Merge pull request #3771 from cweider/python-chores

Author: mlissner

.github/dependabot.yml

@@ -25,4 +25,4 @@ updates:
   groups:
     core:
       patterns:
-        - 'actions/*' # The core actions offered by Github
+        - 'actions/*' # The core actions offered by GitHub

.github/workflows/lint.yml

@@ -70,7 +70,7 @@ jobs:
           -p cl.simple_pages
 
       # Add files here as they're ready
-      - name: mypy Static Type Cheker (files)
+      - name: mypy Static Type Checker (files)
         run: |
           mypy \
           --follow-imports=skip \

cl/api/templates/bulk-data.html

@@ -156,7 +156,7 @@ <h3 id="schedule">Generation Schedule</h3>
     </p>
 
     <h3 id="contributing">Adding Features and Fixing Bugs</h3>
-    <p>Like all Free Law Project initiatives, CourtListener is an open source project. If you are a developer and you notice bugs or missing features, we enthusiastically welcome your contributions <a href="https://github.com/freelawproject/courtlistener">on Github</a>.
+    <p>Like all Free Law Project initiatives, CourtListener is an open source project. If you are a developer and you notice bugs or missing features, we enthusiastically welcome your contributions <a href="https://github.com/freelawproject/courtlistener">on GitHub</a>.
     </p>
 
     <h3 id="old">Release Notes</h3>

cl/api/templates/rest-docs-vlatest.html

@@ -48,12 +48,12 @@ <h2 id="api-overview">Getting Started &amp; Overview</h2>
 
 
     <h2 id="support">Support</h2>
-    <p>Questions about the APIs can be sent <a href="https://github.com/freelawproject/courtlistener/discussions" target="_blank">to our Github Discussions forum</a> or via our <a href="{% url "contact" %}">contact form</a>. In general, we prefer that questions be posted publicly in the forum so they can be searched by others in the future. If you are a private organization posting to that forum, we will work with you to avoid sharing details about your organization.
+    <p>Questions about the APIs can be sent <a href="https://github.com/freelawproject/courtlistener/discussions" target="_blank">to our GitHub Discussions forum</a> or via our <a href="{% url "contact" %}">contact form</a>. In general, we prefer that questions be posted publicly in the forum so they can be searched by others in the future. If you are a private organization posting to that forum, we will work with you to avoid sharing details about your organization.
     </p>
     <p>
       <a href="https://github.com/freelawproject/courtlistener/discussions"
           target="_blank"
-          class="btn btn-default">Ask in Github Discussions</a>
+          class="btn btn-default">Ask in GitHub Discussions</a>
       <a href="{% url "contact" %}"
          target="_blank"
          class="btn btn-default">Send us a Private Message</a>

cl/citations/annotate_citations.py

@@ -13,7 +13,7 @@ def get_and_clean_opinion_text(document: Opinion | RECAPDocument) -> None:
     on the Opinion object. This should be done before performing citation
     extraction and annotation on an opinion.
 
-    :param opinion: The Opinion whose text should be parsed
+    :param document: The Opinion or RECAPDocument whose text should be parsed
     """
     for attr in ["html_anon_2020", "html_columbia", "html_lawbox", "html"]:
         text = getattr(document, attr, None)
@@ -39,7 +39,7 @@ def generate_annotations(
 ) -> List[List]:
     """Generate the string annotations to insert into the opinion text
 
-    :param citations: A list of citations in the opinion
+    :param citation_resolutions: A map of lists of citations in the opinion
     :return The new HTML containing citations
     """
     annotations: List[List] = []
@@ -69,7 +69,7 @@ def create_cited_html(
     the citations into links to the correct citations.
 
     :param opinion: The opinion to enhance
-    :param citations: A list of citations in the opinion
+    :param citation_resolutions: A map of lists of citations in the opinion
     :return The new HTML containing citations
     """
     if opinion.source_is_html:  # If opinion was originally HTML...

cl/corpus_importer/import_columbia/columbia_utils.py

@@ -540,9 +540,9 @@ def convert_columbia_html(text: str, opinion_index: int) -> str:
         # We use opinion index to ensure that all footnotes are linked to the
         # corresponding opinion
         for ref in foot_references:
-            if (match := re.search(r"[\*\d]+", ref)) is not None:
+            if (match := re.search(r"[*\d]+", ref)) is not None:
                 f_num = match.group()
-            elif (match := re.search(r"\[fn(.+)\]", ref)) is not None:
+            elif (match := re.search(r"\[fn(.+)]", ref)) is not None:
                 f_num = match.group(1)
             else:
                 f_num = None
@@ -552,24 +552,24 @@ def convert_columbia_html(text: str, opinion_index: int) -> str:
 
         # Add footnotes to opinion
         footnotes = re.findall(
-            "<footnote_body>.[\s\S]*?</footnote_body>", text
+            r"<footnote_body>.[\s\S]*?</footnote_body>", text
         )
         for fn in footnotes:
             content = re.search(
-                "<footnote_body>(.[\s\S]*?)</footnote_body>", fn
+                r"<footnote_body>(.[\s\S]*?)</footnote_body>", fn
             )
             if content:
                 rep = r'<div class="footnote">%s</div>' % content.group(1)
                 text = text.replace(fn, rep)
 
         # Replace footnote numbers
         foot_numbers = re.findall(
-            "<footnote_number>.*?</footnote_number>", text
+            r"<footnote_number>.*?</footnote_number>", text
         )
         for ref in foot_numbers:
-            if (match := re.search(r"[\*\d]+", ref)) is not None:
+            if (match := re.search(r"[*\d]+", ref)) is not None:
                 f_num = match.group()
-            elif (match := re.search(r"\[fn(.+)\]", ref)) is not None:
+            elif (match := re.search(r"\[fn(.+)]", ref)) is not None:
                 f_num = match.group(1)
             else:
                 f_num = None

cl/corpus_importer/tests.py

@@ -2982,7 +2982,7 @@ def test_judge_name_extraction(self):
 
         test_pairs = [
             (
-                # Test if we are tripped up by mulitple judge names in tag
+                # Test if we are tripped up by multiple judge names in tag
                 "ARNOLD, Circuit Judge, with whom BRIGHT, Senior Circuit Judge, and McMILLIAN and MAGILL, Circuit Judges, join,:",
                 "Arnold",
             ),
@@ -3061,7 +3061,7 @@ def test_panel_extraction(self):
 
         test_pairs = [
             (
-                # Test if we are tripped up by mulitple judge names in tag
+                # Test if we are tripped up by multiple judge names in tag
                 "ARNOLD, Circuit Judge, with whom BRIGHT, Senior Circuit Judge, and McMILLIAN and MAGILL, Circuit Judges, join,:",
                 ["ARNOLD", "BRIGHT", "MAGILL", "McMILLIAN"],
             ),

cl/lib/auth.py

@@ -2,7 +2,7 @@
 
 
 def group_required(*group_names):
-    """Verify user group memebership
+    """Verify user group membership
 
     :param group_names: Array of strings
     :return: Whether the user is in one of the groups

cl/lib/celery_utils.py

@@ -37,7 +37,7 @@ def make_queue_name_for_pri(queue: str, pri: int) -> str:
 
      - batch1\x06\x163 <-- P3 queue named batch1
 
-    There's more information about this in Github, but it doesn't look like it
+    There's more information about this in GitHub, but it doesn't look like it
     will change any time soon:
 
       - https://github.com/celery/kombu/issues/422

cl/lib/context_processors.py

@@ -42,7 +42,7 @@ def inject_settings(request):
     'Free Law Project is a member of the <a href="http://www.falm.info/">Free Access to Law Movement</a> and relies heavily on <a href="%s?referrer=tip">your donations</a>. <i class="fa fa-heart red"></i>'
     % DONATE_URL,
     'Free Law Project, the non-profit behind CourtListener, provides <a href="https://free.law/data-consulting/">data consulting and client services</a> for those that need help with our data.',
-    'If you have a Github account, you <a href="https://github.com/sponsors/freelawproject/">can sponsor our work</a> so we can do more of it. <i class="fa fa-heart red"></i>',
+    'If you have a GitHub account, you <a href="https://github.com/sponsors/freelawproject/">can sponsor our work</a> so we can do more of it. <i class="fa fa-heart red"></i>',
     # Recognition
     'Free Law Project\'s founders were <a href="https://free.law/2014/07/14/free-law-project-co-founders-named-to-fastcase-50-for-2014/">selected as FastCase 50 winners in 2014</a>.',
     'Oral Arguments were <a href="https://free.law/2014/12/04/free-law-project-recognized-in-two-of-top-ten-legal-hacks-of-2014-by-dc-legal-hackers/">selected as a Top Ten Legal Hack of 2014</a>.',

cl/lib/neon_utils.py

@@ -102,7 +102,7 @@ def get_individual_account_payload(
 
         Returns:
             dict[str, dict[str, NeonContact]]:A dictionary containing the
-            extracted data, ready to be used as a payload for the create/update ç
+            extracted data, ready to be used as a payload for the create/update
             request.
         """
         contact_data: NeonContact = {

cl/lib/string_utils.py

@@ -110,7 +110,7 @@ def normalize_dashes(text: str) -> str:
     :return: the better text
     """
     # Simple variables b/c in monospace code, you can't see the difference
-    # othewise.
+    # otherwise.
     normal_dash = "-"
     en_dash = "–"
     em_dash = "—"

cl/people_db/import_judges/judge_utils.py

@@ -45,7 +45,8 @@ def process_date_string(date_input):
 
 
 def get_school(schoolname, testing=False):
-    "Takes the name of a school from judges data and tries to match to a unique School object."
+    """Takes the name of a school from judges data and tries to match to a
+    unique School object."""
 
     if schoolname.isspace():
         return None

cl/people_db/models.py

@@ -1268,7 +1268,7 @@ class Race(models.Model):
     )
 
     def __str__(self) -> str:
-        # This is used in the API via the StringRelatedField. Do not cthange.
+        # This is used in the API via the StringRelatedField. Do not change.
         return f"{self.race}"
 
 

cl/search/signals.py

@@ -555,7 +555,7 @@ def handle_recap_doc_change(
     # When we get updated text for a doc, we want to parse it for citations.
     if update_fields is not None and "plain_text" in update_fields:
         # Even though the task itself filters for qualifying ocr_status,
-        # we don't want to clog the TQ with unncessary items.
+        # we don't want to clog the TQ with unnecessary items.
         if instance.ocr_status in (
             RECAPDocument.OCR_COMPLETE,
             RECAPDocument.OCR_UNNECESSARY,

cl/simple_pages/templates/contact_form.html

@@ -12,7 +12,7 @@ <h1 class="text-center v-offset-below-2">Contact Us</h1>
     </p>
     <p><strong>If you want something taken off of our website</strong>, please see our <a href="{% url "terms" %}#removal">removal policy</a> for how to proceed. You <em>must</em> provide a link of the item you need reviewed.
     </p>
-    <p><strong>Finally</strong>, <a href="https://github.com/freelawproject/courtlistener/discussions" target="_blank">we use Github Discussions</a>, where you can ask questions and search past ones if you prefer to discuss your message in public.</p>
+    <p><strong>Finally</strong>, <a href="https://github.com/freelawproject/courtlistener/discussions" target="_blank">we use GitHub Discussions</a>, where you can ask questions and search past ones if you prefer to discuss your message in public.</p>
 
     {% if form.errors %}
       <div class="alert alert-danger">

cl/simple_pages/templates/faq.html

@@ -389,7 +389,7 @@ <h3 id="orgin-story">What's the History of CourtListener?</h3>
     </p>
 
     <h3 id="future">What Plans or Features Are In the Works?</h3>
-    <p>All of the planning for CourtListener is done on Github and via our Slack room. If you want to get involved, a good way is to send us your résumé by email. In your email, it helps to say what kinds of expertise you have and what kind of help you think you can provide.
+    <p>All of the planning for CourtListener is done on GitHub and via our Slack room. If you want to get involved, a good way is to send us your résumé by email. In your email, it helps to say what kinds of expertise you have and what kind of help you think you can provide.
     </p>
 
 

cl/simple_pages/templates/help/coverage_opinions.html

@@ -80,7 +80,7 @@ <h1>Data Coverage — What Case Law Do We Have?</h1>
     We make our data available in <a href="https://www.courtlistener.com/help/api/">numerous formats</a>. Our hope is that when our work is done, it will never need to be done again — All American jurisprudence will be available to all, forever.</p>
 
     <p><strong>Support —</strong>
-    Questions about our coverage can be sent to our <a href="https://github.com/freelawproject/courtlistener/discussions" target="_blank">to our Github Discussions forum</a> or via our <a href="{% url "contact" %}">contact form</a>. In general, we prefer that questions be posted publicly in the forum so they can be searched by others in the future. If you are a private organization posting to that forum, we will work with you to avoid sharing details about your organization.</p>
+    Questions about our coverage can be sent to our <a href="https://github.com/freelawproject/courtlistener/discussions" target="_blank">to our GitHub Discussions forum</a> or via our <a href="{% url "contact" %}">contact form</a>. In general, we prefer that questions be posted publicly in the forum so they can be searched by others in the future. If you are a private organization posting to that forum, we will work with you to avoid sharing details about your organization.</p>
 
     <p><strong>Finally —</strong> Don’t take our word for it, check it out below.</p>
     <h1 id="federal">Federal Courts</h1>