Fix TODO comments and typos

Author: shenxianpeng

pkg_resources/__init__.py

@@ -3326,9 +3326,6 @@ def has_version(self) -> bool:
         except ValueError:
             issue_warning("Unbuilt egg for " + repr(self))
             return False
-        except SystemError:
-            # TODO: remove this except clause when python/cpython#103632 is fixed.
-            return False
         return True
 
     def clone(self, **kw: str | int | IResourceProvider | None) -> Self:

setuptools/_static.py

@@ -27,7 +27,7 @@ class Static:
 def _prevent_modification(target: type, method: str, copying: str) -> None:
     """
     Because setuptools is very flexible we cannot fully prevent
-    plugins and user customisations from modifying static values that were
+    plugins and user customizations from modifying static values that were
     parsed from config files.
     But we can attempt to block "in-place" mutations and identify when they
     were done.

setuptools/_vendor/autocommand/autoparse.py

@@ -137,7 +137,7 @@ def _add_arguments(param, parser, used_char_args, add_nos):
             arg_spec['type'] = str
 
         # TODO: special case for list type.
-        #   - How to specificy type of list members?
+        #   - How to specify type of list members?
         #       - param: [int]
         #       - param: int =[]
         #   - action='append' vs nargs='*'

setuptools/_vendor/packaging/metadata.py

@@ -193,10 +193,10 @@ def _parse_project_urls(data: list[str]) -> dict[str, str]:
         # be the missing value, then they'd have multiple '' values that
         # overwrite each other in a accumulating dict.
         #
-        # The other potentional issue is that it's possible to have the
+        # The other potential issue is that it's possible to have the
         # same label multiple times in the metadata, with no solid "right"
         # answer with what to do in that case. As such, we'll do the only
-        # thing we can, which is treat the field as unparseable and add it
+        # thing we can, which is treat the field as unparsable and add it
         # to our list of unparsed fields.
         parts = [p.strip() for p in pair.split(",", 1)]
         parts.extend([""] * (max(0, 2 - len(parts))))  # Ensure 2 items
@@ -209,8 +209,8 @@ def _parse_project_urls(data: list[str]) -> dict[str, str]:
         label, url = parts
         if label in urls:
             # The label already exists in our set of urls, so this field
-            # is unparseable, and we can just add the whole thing to our
-            # unparseable data and stop processing it.
+            # is unparsable, and we can just add the whole thing to our
+            # unparsable data and stop processing it.
             raise KeyError("duplicate labels in project urls")
         urls[label] = url
 

setuptools/command/editable_wheel.py

@@ -278,7 +278,7 @@ def _run_build_subcommands(self) -> None:
         This method implements a temporary workaround to support the ecosystem
         while the implementations catch up.
         """
-        # TODO: Once plugins/customisations had the chance to catch up, replace
+        # TODO: Once plugins/customizations had the chance to catch up, replace
         #       `self._run_build_subcommands()` with `self.run_command("build")`.
         #       Also remove _safely_run, TestCustomBuildPy. Suggested date: Aug/2023.
         build = self.get_finalized_command("build")
@@ -309,7 +309,7 @@ def _safely_run(self, cmd_name: str):
                 https://setuptools.pypa.io/en/latest/userguide/extension.html.
 
                 For the time being `setuptools` will silence this error and ignore
-                the faulty command, but this behaviour will change in future versions.
+                the faulty command, but this behavior will change in future versions.
                 """,
                 # TODO: define due_date
                 # There is a series of shortcomings with the available editable install
@@ -564,7 +564,7 @@ def _encode_pth(content: str) -> bytes:
     .pth files are always read with 'locale' encoding, the recommendation
     from the cpython core developers is to write them as ``open(path, "w")``
     and ignore warnings (see python/cpython#77102, pypa/setuptools#3937).
-    This function tries to simulate this behaviour without having to create an
+    This function tries to simulate this behavior without having to create an
     actual file, in a way that supports a range of active Python versions.
     (There seems to be some variety in the way different version of Python handle
     ``encoding=None``, not all of them use ``locale.getpreferredencoding(False)``

setuptools/command/install.py

@@ -68,7 +68,7 @@ def initialize_options(self):
             """,
             see_url="https://blog.ganssle.io/articles/2021/10/setup-py-deprecated.html",
             # TODO: Document how to bootstrap setuptools without install
-            #       (e.g. by unziping the wheel file)
+            #       (e.g. by unzipping the wheel file)
             #       and then add a due_date to this warning.
         )
 

setuptools/tests/test_build_py.py

@@ -168,7 +168,7 @@ def test_excluded_subpackages(tmpdir_cwd):
     with pytest.warns(SetuptoolsDeprecationWarning, match=msg):
         # TODO: To fix #3260 we need some transition period to deprecate the
         # existing behavior of `include_package_data`. After the transition, we
-        # should remove the warning and fix the behaviour.
+        # should remove the warning and fix the behavior.
 
         if os.getenv("SETUPTOOLS_USE_DISTUTILS") == "stdlib":
             # pytest.warns reset the warning filter temporarily

setuptools/unicode_utils.py

@@ -86,7 +86,7 @@ class _Utf8EncodingNeeded(SetuptoolsDeprecationWarning):
     """
 
     _DETAILS = """
-    Fallback behaviour for UTF-8 is considered **deprecated** and future versions of
+    Fallback behavior for UTF-8 is considered **deprecated** and future versions of
     `setuptools` may not implement it.
 
     Please encode {file!r} with "utf-8" to ensure future builds will succeed.