fix!: Fix shadowing of python builtins

conftest.py:87:5: A001 Variable `dir` is shadowing a Python builtin
docs/conf.py:56:1: A001 Variable `copyright` is shadowing a Python builtin
src/vcspull/_internal/config_reader.py:29:15: A002 Argument `format` is shadowing a Python builtin
src/vcspull/_internal/config_reader.py:53:19: A002 Argument `format` is shadowing a Python builtin
src/vcspull/_internal/config_reader.py:109:13: A001 Variable `format` is shadowing a Python builtin
src/vcspull/_internal/config_reader.py:111:13: A001 Variable `format` is shadowing a Python builtin
src/vcspull/_internal/config_reader.py:163:9: A002 Argument `format` is shadowing a Python builtin
src/vcspull/_internal/config_reader.py:192:20: A002 Argument `format` is shadowing a Python builtin
tests/helpers.py:54:25: A002 Argument `format` is shadowing a Python builtin
Found 9 errors.

Author: tony

conftest.py

@@ -84,11 +84,11 @@ def set_xdg_config_path(
 @pytest.fixture(scope="function")
 def repos_path(user_path: pathlib.Path, request: pytest.FixtureRequest) -> pathlib.Path:
     """Return temporary directory for repository checkout guaranteed unique."""
-    dir = user_path / "repos"
-    dir.mkdir(exist_ok=True)
+    path = user_path / "repos"
+    path.mkdir(exist_ok=True)
 
     def clean() -> None:
-        shutil.rmtree(dir)
+        shutil.rmtree(path)
 
     request.addfinalizer(clean)
-    return dir
+    return path

docs/conf.py

@@ -53,7 +53,7 @@
 master_doc = "index"
 
 project = about["__title__"]
-copyright = about["__copyright__"]
+project_copyright = about["__copyright__"]
 
 version = "%s" % (".".join(about["__version__"].split("."))[:2])
 release = "%s" % (about["__version__"])

src/vcspull/_internal/config_reader.py

@@ -26,7 +26,7 @@ def __init__(self, content: "RawConfigData") -> None:
         self.content = content
 
     @staticmethod
-    def _load(format: "FormatLiteral", content: str) -> dict[str, t.Any]:
+    def _load(fmt: "FormatLiteral", content: str) -> dict[str, t.Any]:
         """Load raw config data and directly return it.
 
         >>> ConfigReader._load("json", '{ "session_name": "my session" }')
@@ -35,22 +35,22 @@ def _load(format: "FormatLiteral", content: str) -> dict[str, t.Any]:
         >>> ConfigReader._load("yaml", 'session_name: my session')
         {'session_name': 'my session'}
         """
-        if format == "yaml":
+        if fmt == "yaml":
             return t.cast(
                 dict[str, t.Any],
                 yaml.load(
                     content,
                     Loader=yaml.SafeLoader,
                 ),
             )
-        elif format == "json":
+        elif fmt == "json":
             return t.cast(dict[str, t.Any], json.loads(content))
         else:
-            msg = f"{format} not supported in configuration"
+            msg = f"{fmt} not supported in configuration"
             raise NotImplementedError(msg)
 
     @classmethod
-    def load(cls, format: "FormatLiteral", content: str) -> "ConfigReader":
+    def load(cls, fmt: "FormatLiteral", content: str) -> "ConfigReader":
         """Load raw config data into a ConfigReader instance (to dump later).
 
         >>> cfg = ConfigReader.load("json", '{ "session_name": "my session" }')
@@ -67,7 +67,7 @@ def load(cls, format: "FormatLiteral", content: str) -> "ConfigReader":
         """
         return cls(
             content=cls._load(
-                format=format,
+                fmt=fmt,
                 content=content,
             ),
         )
@@ -106,15 +106,15 @@ def _from_file(cls, path: pathlib.Path) -> dict[str, t.Any]:
         content = path.open().read()
 
         if path.suffix in [".yaml", ".yml"]:
-            format: "FormatLiteral" = "yaml"
+            fmt: "FormatLiteral" = "yaml"
         elif path.suffix == ".json":
-            format = "json"
+            fmt = "json"
         else:
             msg = f"{path.suffix} not supported in {path}"
             raise NotImplementedError(msg)
 
         return cls._load(
-            format=format,
+            fmt=fmt,
             content=content,
         )
 
@@ -160,7 +160,7 @@ def from_file(cls, path: pathlib.Path) -> "ConfigReader":
 
     @staticmethod
     def _dump(
-        format: "FormatLiteral",
+        fmt: "FormatLiteral",
         content: "RawConfigData",
         indent: int = 2,
         **kwargs: t.Any,
@@ -173,23 +173,23 @@ def _dump(
         >>> ConfigReader._dump("json", { "session_name": "my session" })
         '{\n  "session_name": "my session"\n}'
         """
-        if format == "yaml":
+        if fmt == "yaml":
             return yaml.dump(
                 content,
                 indent=2,
                 default_flow_style=False,
                 Dumper=yaml.SafeDumper,
             )
-        elif format == "json":
+        elif fmt == "json":
             return json.dumps(
                 content,
                 indent=2,
             )
         else:
-            msg = f"{format} not supported in config"
+            msg = f"{fmt} not supported in config"
             raise NotImplementedError(msg)
 
-    def dump(self, format: "FormatLiteral", indent: int = 2, **kwargs: t.Any) -> str:
+    def dump(self, fmt: "FormatLiteral", indent: int = 2, **kwargs: t.Any) -> str:
         r"""Dump via ConfigReader instance.
 
         >>> cfg = ConfigReader({ "session_name": "my session" })
@@ -199,7 +199,7 @@ def dump(self, format: "FormatLiteral", indent: int = 2, **kwargs: t.Any) -> str
         '{\n  "session_name": "my session"\n}'
         """
         return self._dump(
-            format=format,
+            fmt=fmt,
             content=self.content,
             indent=indent,
             **kwargs,

tests/helpers.py

@@ -51,6 +51,6 @@ def write_config(config_path: pathlib.Path, content: str) -> pathlib.Path:
     return config_path
 
 
-def load_raw(data: str, format: t.Literal["yaml", "json"]) -> dict[str, t.Any]:
+def load_raw(data: str, fmt: t.Literal["yaml", "json"]) -> dict[str, t.Any]:
     """Load configuration data via string value. Accepts yaml or json."""
-    return ConfigReader._load(format=format, content=data)
+    return ConfigReader._load(fmt=fmt, content=data)

tests/test_config_file.py

@@ -31,9 +31,9 @@ def json_config(config_path: pathlib.Path) -> pathlib.Path:
 
 
 def test_dict_equals_yaml() -> None:
-    """Verify that example YAML is returning expected dict format."""
+    """Verify that example YAML is returning expected dict fmt."""
     config = ConfigReader._load(
-        format="yaml",
+        fmt="yaml",
         content="""\
             /home/me/myproject/study/:
               linux: git+git://git.kernel.org/linux/torvalds/linux.git
@@ -142,7 +142,7 @@ def test_expandenv_and_homevars() -> None:
                   .tmux:
                     url: git+file://{git_repo_path}
                 """,
-        format="yaml",
+        fmt="yaml",
     )
     config2 = load_raw(
         """\
@@ -162,7 +162,7 @@ def test_expandenv_and_homevars() -> None:
                   }
                 }
                 """,
-        format="json",
+        fmt="json",
     )
 
     assert is_valid_config(config1)

tests/test_sync.py

@@ -25,7 +25,7 @@ def test_makes_recursive(
 ) -> None:
     """Ensure that syncing creates directories recursively."""
     conf = ConfigReader._load(
-        format="yaml",
+        fmt="yaml",
         content=textwrap.dedent(
             f"""
         {tmp_path}/study/myrepo: