docs: clean up newsfragments, aggregate 4.0.0 contributors so far (#2152

)

* docs: clean up newsfragments, aggregate contributors so far

* chore: fix import order

AUTHORS

@@ -125,6 +125,12 @@ listed below by date of first contribution:
 * Christian Clauss (cclauss)
 * meetshah133
 * Kai Chan (kaichan1201)
+* Patryk Krawaczyński (nfsec)
+* Jarek Kapica (jkapica)
+* TigreModerata
+* John G G (john-g-g)
+* Aryan Iyappan (aryaniyaps)
+* Eujin Ong (euj1n0ng)
 
 (et al.)
 

docs/_newsfragments/2022.newandimproved.rst

@@ -1 +1,3 @@
-:class:`FloatConverter`:Modified existing IntConverter class and added FloatConverter class to convert string to float at runtime.
+Similar to the existing :class:`~falcon.routing.IntConverter`, a new
+:class:`~falcon.routing.FloatConverter` has been added, allowing to convert
+path segments to ``float``.

docs/_newsfragments/648.newandimproved.rst

@@ -1,2 +1,2 @@
-A new ``path`` :class:`converter <~falcon.routing.PathConverter>`
+A new ``path`` :class:`converter <falcon.routing.PathConverter>`
 capable of matching segments that include ``/`` was added.

docs/api/routing.rst

@@ -304,6 +304,9 @@ Built-in Converters
 .. autoclass:: falcon.routing.IntConverter
     :members:
 
+.. autoclass:: falcon.routing.FloatConverter
+    :members:
+
 .. autoclass:: falcon.routing.UUIDConverter
     :members:
 

docs/changes/4.0.0.rst

@@ -23,11 +23,20 @@ Contributors to this Release
 
 Many thanks to all of our talented and stylish contributors for this release!
 
+- `aryaniyaps <https://github.com/aryaniyaps>`__
 - `CaselIT <https://github.com/CaselIT>`__
 - `cclauss <https://github.com/cclauss>`__
+- `euj1n0ng <https://github.com/euj1n0ng>`__
+- `jkapica <https://github.com/jkapica>`__
 - `jkklapp <https://github.com/jkklapp>`__
+- `john-g-g <https://github.com/john-g-g>`__
+- `kaichan1201 <https://github.com/kaichan1201>`__
 - `kgriffs <https://github.com/kgriffs>`__
 - `meetshah133 <https://github.com/meetshah133>`__
 - `mgorny <https://github.com/mgorny>`__
+- `mihaitodor <https://github.com/mihaitodor>`__
+- `nfsec <https://github.com/nfsec>`__
 - `RioAtHome <https://github.com/RioAtHome>`__
+- `TigreModerata <https://github.com/TigreModerata>`__
+- `vgerak <https://github.com/vgerak>`__
 - `vytas7 <https://github.com/vytas7>`__

falcon/routing/__init__.py

@@ -23,6 +23,7 @@
 from falcon.routing.compiled import CompiledRouterOptions
 from falcon.routing.converters import BaseConverter
 from falcon.routing.converters import DateTimeConverter
+from falcon.routing.converters import FloatConverter
 from falcon.routing.converters import IntConverter
 from falcon.routing.converters import PathConverter
 from falcon.routing.converters import UUIDConverter

falcon/routing/converters.py

@@ -19,10 +19,10 @@
 
 __all__ = (
     'BaseConverter',
-    'IntConverter',
     'DateTimeConverter',
-    'UUIDConverter',
     'FloatConverter',
+    'IntConverter',
+    'UUIDConverter',
 )
 
 
@@ -114,6 +114,7 @@ class FloatConverter(IntConverter):
     """Converts a field value to an float.
 
     Identifier: `float`
+
     Keyword Args:
         min (float): Reject the value if it is less than this number.
         max (float): Reject the value if it is greater than this number.

tools/add_contributors.py

@@ -22,31 +22,39 @@
 RST_CONTRIBUTOR_TEMPLATE = '- `{login} <https://github.com/{login}>`__\n'
 
 
-def get_latest_tag():
+def get_latest_tag(headers=None):
     uri = f'{FALCON_REPOSITORY_API}/tags'
-    for tag in requests.get(uri).json():
+    resp = requests.get(uri, headers=headers)
+    resp.raise_for_status()
+
+    for tag in resp.json():
         if re.match(STABLE_RELEASE_TAG, tag['name']):
             return tag['name'], tag['commit']['sha']
 
 
-def iter_commits(until=None):
+def iter_commits(until=None, headers=None):
     page = 1
     uri = f'{FALCON_REPOSITORY_API}/commits'
+    resp = requests.get(uri, headers=headers)
+    resp.raise_for_status()
 
-    while commits := requests.get(uri).json():
+    while commits := resp.json():
         for commit in commits:
-            if until and commit['sha'] == until:
+            if until and commit['sha'].startswith(until):
                 return
             yield commit
 
         page += 1
         uri = f'{FALCON_REPOSITORY_API}/commits?page={page}'
+        resp = requests.get(uri, headers=headers)
+        resp.raise_for_status()
 
 
-def aggregate_contributors(until=None):
+def aggregate_contributors(until=None, headers=None):
     result = {}
-    for commit in iter_commits(until):
-        login = commit['author'].get('login')
+    for commit in iter_commits(until, headers=headers):
+        author = commit.get('author') or {}
+        login = author.get('login')
         if not login:
             continue
         if login in result:
@@ -121,6 +129,14 @@ def main():
         'Optionally append them to AUTHORS and the active Towncrier template.'
     )
     parser = argparse.ArgumentParser(description=description)
+    parser.add_argument(
+        '-a', '--auth', help='supply authentication token for GitHub requests'
+    )
+    parser.add_argument(
+        '-t',
+        '--treeish',
+        help='aggregate since this commit (default: detect latest tag)',
+    )
     parser.add_argument(
         '-n', '--dry-run', action='store_true', help='dry run: do not write any files'
     )
@@ -131,12 +147,19 @@ def main():
         '--no-towncrier', action='store_true', help=f'do not write {towncrier_template}'
     )
     args = parser.parse_args()
+    headers = {'Authorization': f'Bearer {args.auth}'} if args.auth else None
+
+    if args.treeish:
+        commit = args.treeish
+        info = f'Contributors since commit {commit}):'
+    else:
+        tag, commit = get_latest_tag(headers=headers)
+        info = f'Contributors since the latest stable tag ({tag}):'
 
-    tag, commit = get_latest_tag()
-    contributors = aggregate_contributors(until=commit)
+    contributors = aggregate_contributors(until=commit, headers=headers)
 
     if contributors:
-        print(f'Contributors since the latest stable tag ({tag}):')
+        print(info)
         for login, name in contributors.items():
             print(f' * {name} ({login})')
     else: