Merge branch 'fix/compote_upload_without_idf' into 'main'

fix: filterwarning "Running in an environment without IDF" while uploading

Closes PACMAN-964

See merge request espressif/idf-component-manager!429

Author: kumekay

idf_component_manager/core.py

@@ -48,6 +48,7 @@
 )
 from idf_component_tools.manager import (
     ManifestManager,
+    UploadMode,
 )
 from idf_component_tools.manifest import (
     WEB_DEPENDENCY_REGEX,
@@ -404,7 +405,7 @@ def pack_component(
         manifest_manager = ManifestManager(
             self.path,
             name,
-            upload_mode=True,
+            upload_mode=UploadMode.component,
             version=version,
             repository=repository,
             commit_sha=commit_sha,
@@ -561,7 +562,7 @@ def upload_component(
                 manifest = ManifestManager(
                     tempdir,
                     name,
-                    upload_mode=True,
+                    upload_mode=UploadMode.component,
                     repository=repository,
                     commit_sha=commit_sha,
                     repository_path=repository_path,

idf_component_tools/manager.py

@@ -1,6 +1,6 @@
 # SPDX-FileCopyrightText: 2022-2024 Espressif Systems (Shanghai) CO LTD
 # SPDX-License-Identifier: Apache-2.0
-
+import enum
 import os
 import typing as t
 from pathlib import Path
@@ -14,6 +14,12 @@
     from .manifest.models import Manifest
 
 
+class UploadMode(str, enum.Enum):
+    false = 'false'
+    component = 'component'
+    example = 'example'
+
+
 class ManifestManager:
     """
     Parser for manifest files in the project.
@@ -24,7 +30,7 @@ def __init__(
         path: str,
         name: str,
         *,
-        upload_mode: bool = False,
+        upload_mode: UploadMode = UploadMode.false,
         # override fields
         version: t.Optional[str] = None,
         repository: t.Optional[str] = None,

idf_component_tools/manifest/models.py

@@ -1,6 +1,7 @@
 # SPDX-FileCopyrightText: 2024 Espressif Systems (Shanghai) CO LTD
 # SPDX-License-Identifier: Apache-2.0
 import typing as t
+import warnings
 from copy import deepcopy
 
 from pydantic import (
@@ -50,13 +51,11 @@
     validation_error_to_str,
 )
 
+from ..manager import UploadMode
 from ..semver import Version
 from .constants import COMPILED_FULL_SLUG_REGEX, known_targets
 from .if_parser import IfClause, parse_if_clause
 
-if t.TYPE_CHECKING:
-    pass
-
 
 class OptionalDependency(BaseModel):
     # use alias since `if` is a keyword
@@ -345,15 +344,15 @@ class Manifest(BaseModel):
     discussion: UrlField = None  # type: ignore
     repository_info: RepositoryInfoField = None  # type: ignore
 
-    _upload_mode: bool = False
+    _upload_mode: UploadMode = UploadMode.false
 
     def __init__(
         self,
         **kwargs,
     ):
         super().__init__(**kwargs)
 
-        self._upload_mode = kwargs.pop('upload_mode', False)
+        self._upload_mode = kwargs.pop('upload_mode', UploadMode.false)
 
         self.validate_post_init()
 
@@ -382,7 +381,7 @@ def validate_post_init(self) -> None:
         if not self.repository and self.repository_info:
             raise ValueError('Invalid field "repository". Must set when "repository_info" is set')
 
-        if self._upload_mode:
+        if self._upload_mode != UploadMode.false:
             self._validate_while_uploading()
 
     def model_dump(
@@ -472,7 +471,7 @@ def validate_manifest(
         cls,
         obj: t.Any,
         *,
-        upload_mode: bool = False,
+        upload_mode: UploadMode = UploadMode.false,
         return_with_object: bool = False,
         # pydantic options
         strict: t.Optional[bool] = None,
@@ -487,12 +486,18 @@ def validate_manifest(
 
         obj['upload_mode'] = upload_mode
         try:
-            res = super().model_validate(
-                obj,
-                strict=strict,
-                from_attributes=from_attributes,
-                context=context,
-            )
+            with warnings.catch_warnings():
+                if upload_mode != UploadMode.false:
+                    warnings.filterwarnings(
+                        'ignore', message='^Running in an environment without IDF.'
+                    )
+
+                res = super().model_validate(
+                    obj,
+                    strict=strict,
+                    from_attributes=from_attributes,
+                    context=context,
+                )
         except ValidationError as e:
             errors = e.errors(include_url=False)
 

tests/manifest/test_validator.py

@@ -7,7 +7,7 @@
 import pytest
 
 from idf_component_manager.dependencies import detect_unused_components
-from idf_component_tools.manager import ManifestManager
+from idf_component_tools.manager import ManifestManager, UploadMode
 from idf_component_tools.manifest import SLUG_REGEX, OptionalRequirement, SolvedComponent
 from idf_component_tools.manifest.constants import DEFAULT_KNOWN_TARGETS, known_targets
 from idf_component_tools.manifest.if_parser import parse_if_clause
@@ -110,7 +110,7 @@ def test_validate_targets_unknown(self, valid_manifest):
 
         assert not errors
 
-        errors = Manifest.validate_manifest(valid_manifest, upload_mode=True)
+        errors = Manifest.validate_manifest(valid_manifest, upload_mode=UploadMode.component)
 
         assert errors == ['Invalid field "targets". Unknown targets: "asdf,esp123"']
 
@@ -153,12 +153,12 @@ def test_validate_version_list(self, valid_manifest):
         assert not errors
 
     def test_check_required_keys(self, valid_manifest):
-        errors = Manifest.validate_manifest(valid_manifest, upload_mode=True)
+        errors = Manifest.validate_manifest(valid_manifest, upload_mode=UploadMode.component)
 
         assert not errors
 
     def test_check_required_keys_empty_manifest(self):
-        errors = Manifest.validate_manifest({}, upload_mode=True)
+        errors = Manifest.validate_manifest({}, upload_mode=UploadMode.component)
 
         assert errors == [
             'Invalid field "version". Must set while uploading component to the registry'
@@ -443,7 +443,7 @@ def test_validate_optional_dependency_success(
         self, valid_optional_dependency_manifest_with_idf
     ):
         errors = Manifest.validate_manifest(
-            valid_optional_dependency_manifest_with_idf, upload_mode=True
+            valid_optional_dependency_manifest_with_idf, upload_mode=UploadMode.component
         )
 
         assert not errors
@@ -470,7 +470,7 @@ def test_validate_optional_dependency_invalid(
             'if'
         ] = invalid_str
         errors = Manifest.validate_manifest(
-            valid_optional_dependency_manifest_with_idf, upload_mode=True
+            valid_optional_dependency_manifest_with_idf, upload_mode=UploadMode.component
         )
 
         assert errors == expected_errors
@@ -500,7 +500,7 @@ def test_validate_optional_dependency_invalid_derived(
             'if'
         ] = invalid_str
         errors = Manifest.validate_manifest(
-            valid_optional_dependency_manifest_with_idf, upload_mode=True
+            valid_optional_dependency_manifest_with_idf, upload_mode=UploadMode.component
         )
 
         assert errors == expected_errors