Update files

hooks/gen_schema.py

@@ -5,8 +5,8 @@
 from pathlib import Path
 
 from hooks import ROOT
+from kpops.api.file_type import KpopsFileType
 from kpops.utils.gen_schema import (
-    SchemaScope,
     gen_config_schema,
     gen_defaults_schema,
     gen_pipeline_schema,
@@ -15,7 +15,7 @@
 PATH_TO_SCHEMA = ROOT / "docs/docs/schema"
 
 
-def gen_schema(scope: SchemaScope):
+def gen_schema(scope: KpopsFileType):
     """Generate the specified schema and save it to a file.
 
     The file is located in docs/docs/schema and is named ``<scope.value>.json``
@@ -24,16 +24,16 @@ def gen_schema(scope: SchemaScope):
     """
     with redirect_stdout(StringIO()) as f:
         match scope:
-            case SchemaScope.PIPELINE:
+            case KpopsFileType.PIPELINE:
                 gen_pipeline_schema()
-            case SchemaScope.DEFAULTS:
+            case KpopsFileType.DEFAULTS:
                 gen_defaults_schema()
-            case SchemaScope.CONFIG:
+            case KpopsFileType.CONFIG:
                 gen_config_schema()
         Path(PATH_TO_SCHEMA / f"{scope.value}.json").write_text(f.getvalue())
 
 
 if __name__ == "__main__":
-    gen_schema(SchemaScope.PIPELINE)
-    gen_schema(SchemaScope.DEFAULTS)
-    gen_schema(SchemaScope.CONFIG)
+    gen_schema(KpopsFileType.PIPELINE)
+    gen_schema(KpopsFileType.DEFAULTS)
+    gen_schema(KpopsFileType.CONFIG)

kpops/api/kpops_resources.py → kpops/api/file_type.py

@@ -1,9 +1,11 @@
+from __future__ import annotations
+
 from enum import Enum
 
 FILE_PREFIX = ".yaml"
 
 
-class KpopsResources(str, Enum):
+class KpopsFileType(str, Enum):
     PIPELINE = "pipeline"
     DEFAULTS = "defaults"
     CONFIG = "config"

kpops/cli/main.py

@@ -7,10 +7,10 @@
 
 import kpops
 from kpops import __version__
+from kpops.api.file_type import KpopsFileType
 from kpops.api.options import FilterType
 from kpops.config import ENV_PREFIX, KpopsConfig
 from kpops.utils.gen_schema import (
-    SchemaScope,
     gen_config_schema,
     gen_defaults_schema,
     gen_pipeline_schema,
@@ -125,7 +125,7 @@ def init(
     """
 )
 def schema(
-    scope: SchemaScope = typer.Argument(
+    scope: KpopsFileType = typer.Argument(
         ...,
         show_default=False,
         help="""
@@ -141,17 +141,17 @@ def schema(
     ),
 ) -> None:
     match scope:
-        case SchemaScope.PIPELINE:
+        case KpopsFileType.PIPELINE:
             kpops_config = KpopsConfig.create(config)
             gen_pipeline_schema(
                 kpops_config.components_module, include_stock_components
             )
-        case SchemaScope.DEFAULTS:
+        case KpopsFileType.DEFAULTS:
             kpops_config = KpopsConfig.create(config)
             gen_defaults_schema(
                 kpops_config.components_module, include_stock_components
             )
-        case SchemaScope.CONFIG:
+        case KpopsFileType.CONFIG:
             gen_config_schema()
 
 

kpops/utils/cli_commands.py

@@ -6,7 +6,7 @@
 from pydantic.fields import FieldInfo
 from pydantic_core import PydanticUndefined
 
-from kpops.api.kpops_resources import KpopsResources
+from kpops.api.file_type import KpopsFileType
 from kpops.config import KpopsConfig
 from kpops.utils.docstring import describe_object
 from kpops.utils.json import is_jsonable
@@ -73,6 +73,6 @@ def init_project(path: Path, conf_incl_opt: bool):
     :param conf_incl_opt: Whether to include non-required settings
         in the generated config file
     """
-    create_config(KpopsResources.CONFIG.value, path, conf_incl_opt)
-    Path(path / KpopsResources.PIPELINE.as_yaml_file()).touch(exist_ok=False)
-    Path(path / KpopsResources.DEFAULTS.as_yaml_file()).touch(exist_ok=False)
+    create_config(KpopsFileType.CONFIG.value, path, conf_incl_opt)
+    Path(path / KpopsFileType.PIPELINE.as_yaml_file()).touch(exist_ok=False)
+    Path(path / KpopsFileType.DEFAULTS.as_yaml_file()).touch(exist_ok=False)

kpops/utils/gen_schema.py

@@ -3,7 +3,6 @@
 import logging
 from abc import ABC
 from collections.abc import Sequence
-from enum import Enum
 from typing import Annotated, Any, Literal, Union
 
 from pydantic import (
@@ -28,12 +27,6 @@
 from kpops.config import KpopsConfig
 
 
-class SchemaScope(str, Enum):
-    PIPELINE = "pipeline"
-    DEFAULTS = "defaults"
-    CONFIG = "config"
-
-
 class MultiComponentGenerateJsonSchema(GenerateJsonSchema): ...
 
 

tests/compiler/test_pipeline_name.py

@@ -2,12 +2,12 @@
 
 import pytest
 
-from kpops.api.kpops_resources import KpopsResources
+from kpops.api.file_type import KpopsFileType
 from kpops.pipeline import PipelineGenerator
 from kpops.utils.environment import ENV
 
 PIPELINE_PATH = (
-    Path("./some/random/path/for/testing") / KpopsResources.PIPELINE.as_yaml_file()
+    Path("./some/random/path/for/testing") / KpopsFileType.PIPELINE.as_yaml_file()
 )
 
 PIPELINE_BASE_DIR = Path()

tests/components/test_base_defaults_component.py

@@ -6,7 +6,7 @@
 import pydantic
 import pytest
 
-from kpops.api.kpops_resources import KpopsResources
+from kpops.api.file_type import KpopsFileType
 from kpops.component_handlers import ComponentHandlers
 from kpops.components.base_components.base_defaults_component import (
     BaseDefaultsComponent,
@@ -17,9 +17,9 @@
 from kpops.utils.environment import ENV
 from tests.components import PIPELINE_BASE_DIR, RESOURCES_PATH
 
-PIPELINE_YAML = KpopsResources.PIPELINE.as_yaml_file()
+PIPELINE_YAML = KpopsFileType.PIPELINE.as_yaml_file()
 
-DEFAULTS_YAML = KpopsResources.DEFAULTS.as_yaml_file()
+DEFAULTS_YAML = KpopsFileType.DEFAULTS.as_yaml_file()
 
 
 class Parent(BaseDefaultsComponent):
@@ -121,7 +121,7 @@ def test_load_defaults_with_environment(
         assert (
             component_class.load_defaults(
                 RESOURCES_PATH
-                / KpopsResources.DEFAULTS.as_yaml_file(prefix="development"),
+                / KpopsFileType.DEFAULTS.as_yaml_file(prefix="_development"),
                 RESOURCES_PATH / DEFAULTS_YAML,
             )
             == defaults

tests/pipeline/test_generate.py

@@ -11,11 +11,11 @@
 
 import kpops
 from kpops.api.exception import ParsingException, ValidationError
-from kpops.api.kpops_resources import KpopsResources
+from kpops.api.file_type import KpopsFileType
 from kpops.cli.main import FilterType, app
 from kpops.components import KafkaSinkConnector, PipelineComponent
 
-PIPELINE_YAML = KpopsResources.PIPELINE.as_yaml_file()
+PIPELINE_YAML = KpopsFileType.PIPELINE.as_yaml_file()
 
 runner = CliRunner()
 
@@ -177,7 +177,7 @@ def test_substitute_in_component_infinite_loop(self):
                     str(
                         RESOURCE_PATH
                         / "component-type-substitution"
-                        / KpopsResources.PIPELINE.as_yaml_file(suffix="infinite_"),
+                        / KpopsFileType.PIPELINE.as_yaml_file(suffix="infinite_"),
                     ),
                 ],
                 catch_exceptions=False,
@@ -817,7 +817,7 @@ def test_substitution_in_resetter(self):
         pipeline = kpops.generate(
             RESOURCE_PATH
             / "resetter_values"
-            / KpopsResources.PIPELINE.as_yaml_file(prefix="_connector_only"),
+            / KpopsFileType.PIPELINE.as_yaml_file(prefix="_connector_only"),
         )
         assert isinstance(pipeline.components[0], KafkaSinkConnector)
         assert pipeline.components[0].name == "es-sink-connector"