From a0c0ddeccfcdc3a6abbf99e563ff08d0c627afaf Mon Sep 17 00:00:00 2001
From: Tim McCormack <tmccormack@edx.org>
Date: Thu, 10 Aug 2023 18:25:44 +0000
Subject: [PATCH] feat: Reconcile mismatches between setup.py in template and
 updater

Just comment wording that has drifted apart over time, though.
---
 .../{{cookiecutter.placeholder_repo_name}}/setup.py   |  8 ++++----
 scripts/update_setup_py_load_requirements.yaml        | 11 ++++++-----
 2 files changed, 10 insertions(+), 9 deletions(-)

diff --git a/python-template/{{cookiecutter.placeholder_repo_name}}/setup.py b/python-template/{{cookiecutter.placeholder_repo_name}}/setup.py
index 2a583a29..6e162cf9 100755
--- a/python-template/{{cookiecutter.placeholder_repo_name}}/setup.py
+++ b/python-template/{{cookiecutter.placeholder_repo_name}}/setup.py
@@ -48,8 +48,8 @@ def add_version_constraint_or_raise(current_line, current_requirements, add_if_n
             package = regex_match.group(1)
             version_constraints = regex_match.group(2)
             existing_version_constraints = current_requirements.get(package, None)
-            # fine to add constraints to an unconstrained package,
-            # raise an error if there are already constraints in place
+            # It's fine to add constraints to an unconstrained package,
+            # but raise an error if there are already constraints in place.
             if existing_version_constraints and existing_version_constraints != version_constraints:
                 raise BaseException(f'Multiple constraint definitions found for {package}:'
                                     f' "{existing_version_constraints}" and "{version_constraints}".'
@@ -58,8 +58,8 @@ def add_version_constraint_or_raise(current_line, current_requirements, add_if_n
             if add_if_not_present or package in current_requirements:
                 current_requirements[package] = version_constraints
 
-    # read requirements from .in
-    # store the path to any constraint files that are pulled in
+    # Read requirements from .in files and store the path to any
+    # constraint files that are pulled in.
     for path in requirements_paths:
         with open(path) as reqs:
             for line in reqs:
diff --git a/scripts/update_setup_py_load_requirements.yaml b/scripts/update_setup_py_load_requirements.yaml
index c0a6946f..e18564f2 100644
--- a/scripts/update_setup_py_load_requirements.yaml
+++ b/scripts/update_setup_py_load_requirements.yaml
@@ -21,7 +21,7 @@ rules:
         requirements = {}
         constraint_files = set()
 
-        # groups "my-package-name<=x.y.z,..." into ("my-package-name", "<=x.y.z,...")
+        # groups "pkg<=x.y.z,..." into ("pkg", "<=x.y.z,...")
         requirement_line_regex = re.compile(r"([a-zA-Z0-9-_.\[\]]+)([<>=][^#\s]+)?")
 
         def add_version_constraint_or_raise(current_line, current_requirements, add_if_not_present):
@@ -30,8 +30,8 @@ rules:
                 package = regex_match.group(1)
                 version_constraints = regex_match.group(2)
                 existing_version_constraints = current_requirements.get(package, None)
-                # it's fine to add constraints to an unconstrained package, but raise an error if there are already
-                # constraints in place
+                # It's fine to add constraints to an unconstrained package,
+                # but raise an error if there are already constraints in place.
                 if existing_version_constraints and existing_version_constraints != version_constraints:
                     raise BaseException(f'Multiple constraint definitions found for {package}:'
                                         f' "{existing_version_constraints}" and "{version_constraints}".'
@@ -40,7 +40,8 @@ rules:
                 if add_if_not_present or package in current_requirements:
                     current_requirements[package] = version_constraints
 
-        # process .in files and store the path to any constraint files that are pulled in
+        # Read requirements from .in files and store the path to any
+        # constraint files that are pulled in.
         for path in requirements_paths:
             with open(path) as reqs:
                 for line in reqs:
@@ -49,7 +50,7 @@ rules:
                     if line and line.startswith('-c') and not line.startswith('-c http'):
                         constraint_files.add(os.path.dirname(path) + '/' + line.split('#')[0].replace('-c', '').strip())
 
-        # process constraint files and add any new constraints found to existing requirements
+        # process constraint files: add constraints to existing requirements
         for constraint_file in constraint_files:
             with open(constraint_file) as reader:
                 for line in reader: