lint

Signed-off-by: Nelson Chen <asd3431090@gmail.com>

Author: arbaobao

flytekit/configuration/__init__.py

@@ -662,6 +662,7 @@ def auto(cls, config_file: typing.Union[str, ConfigFile] = None) -> LocalConfig:
         kwargs = set_if_exists(kwargs, "cache_overwrite", _internal.Local.CACHE_OVERWRITE.read(config_file))
         return LocalConfig(**kwargs)
 
+
 @dataclass(init=True, repr=True, eq=True, frozen=True)
 class FieldConfig(object):
     """
@@ -681,6 +682,7 @@ def auto(cls, config_file: typing.Union[str, ConfigFile] = None) -> FieldConfig:
         kwargs = set_if_exists(kwargs, "org", _internal.Local.USER_ORG.read(config_file))
         return FieldConfig(**kwargs)
 
+
 @dataclass(init=True, repr=True, eq=True, frozen=True)
 class Config(object):
     """
@@ -691,10 +693,13 @@ class Config(object):
     2. Some parts are required for Serialization, for example Platform Config is not required
     3. Runtime of a task
 
-    Args:
-        entrypoint_settings: EntrypointSettings object for use with Spark tasks. If supplied, this will be
-          used when serializing Spark tasks, which need to know the path to the flytekit entrypoint.py file,
-          inside the container.
+    Attributes:
+        platform (PlatformConfig): Settings to connect to a Flyte backend.
+        secrets (SecretsConfig): Configuration for secrets management.
+        stats (StatsConfig): Configuration for statsd metrics.
+        data_config (DataConfig): Data storage configuration.
+        local_sandbox_path (str): Path for local sandbox runs.
+        field_config (FieldConfig): Project/Domain/Org configuration.
     """
 
     platform: PlatformConfig = PlatformConfig()

flytekit/configuration/internal.py

@@ -75,10 +75,27 @@ class Local(object):
     SECTION = "local"
     CACHE_ENABLED = ConfigEntry(LegacyConfigEntry(SECTION, "cache_enabled", bool))
     CACHE_OVERWRITE = ConfigEntry(LegacyConfigEntry(SECTION, "cache_overwrite", bool))
-    USER_PROJECT = ConfigEntry(LegacyConfigEntry(SECTION, "project",),YamlConfigEntry("task.project"))
-    USER_DOMAIN = ConfigEntry(LegacyConfigEntry(SECTION, "domain",),YamlConfigEntry("task.domain"))
-    USER_ORG = ConfigEntry(LegacyConfigEntry(SECTION, "org",),YamlConfigEntry("task.org"))
-
+    USER_PROJECT = ConfigEntry(
+        LegacyConfigEntry(
+            SECTION,
+            "project",
+        ),
+        YamlConfigEntry("task.project"),
+    )
+    USER_DOMAIN = ConfigEntry(
+        LegacyConfigEntry(
+            SECTION,
+            "domain",
+        ),
+        YamlConfigEntry("task.domain"),
+    )
+    USER_ORG = ConfigEntry(
+        LegacyConfigEntry(
+            SECTION,
+            "org",
+        ),
+        YamlConfigEntry("task.org"),
+    )
 
 
 class Credentials(object):

pydoclint-errors-baseline.txt

@@ -13,8 +13,6 @@ flytekit/configuration/__init__.py
     DOC103: Function `_parse_image_identifier`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [image_identifier: str].
     DOC203: Function `_parse_image_identifier` return type(s) in docstring not consistent with the return annotation. Return annotation types: ['typing.Tuple[str, Optional[str], Optional[str]]']; docstring return section types: ['Tuple[str, str, str]']
     DOC605: Class `ImageConfig`: Attribute names match, but type hints in these attributes do not match: images  (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.)
-    DOC601: Class `Config`: Class docstring contains fewer class attributes than actual class attributes.  (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.)
-    DOC603: Class `Config`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [data_config: DataConfig, local_sandbox_path: str, platform: PlatformConfig, secrets: SecretsConfig, stats: StatsConfig]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.)
     DOC603: Class `SerializationSettings`: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [git_repo: Optional[str]]. Arguments in the docstring but not in the actual class attributes: [entrypoint_settings: Optional[EntrypointSettings]]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.)
 --------------------
 flytekit/configuration/file.py