(beta) swap from black to ruff for formatting (#1330)

* (beta) swap from black to ruff * (beta) mass-format with ruff * (beta) add git-blame-ignore-revs
stripe · May 13, 2024 · 0bab95f · 0bab95f
1 parent 81905cd
commit 0bab95f
Show file tree

Hide file tree

Showing 154 changed files with 691 additions and 812 deletions.
diff --git a/.flake8 b/.flake8
@@ -4,7 +4,9 @@
 # length, but can go over in some cases.
 # W503 goes against PEP8 rules. It's disabled by default, but must be disabled
 # explicitly when using `ignore`.
-ignore = E501, W503
+# E704 is disabled in the default configuration, but by specifying `ignore`, we wipe that out.
+# ruff formatting creates code that violates it, so we have to disable it manually
+ignore = E501, W503, E704
 per-file-ignores =
     */__init__.py: IMP100, E402, F401
     # we test various import patterns

diff --git a/.git-blame-ignore-revs b/.git-blame-ignore-revs
@@ -0,0 +1,5 @@
+# .git-blame-ignore-revs
+# mass formatted w/ ruff (2024-05-10)
+c46b4b950ea77e9d18ab98885cda721b3de247c0
+# (beta) mass formatted w/ ruff (2024-05-13)
+11c92dc754cf1e93ed1910624c182aa244d3981c
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
@@ -3,5 +3,6 @@
     "ms-python.python",
     "EditorConfig.editorconfig",
     "ms-python.flake8",
+    "charliermarsh.ruff"
   ]
 }
diff --git a/README.md b/README.md
@@ -382,7 +382,7 @@ Run the linter with:
 make lint
 ```
 
-The library uses [Black][black] for code formatting. Code must be formatted
+The library uses [Ruff][ruff] for code formatting. Code must be formatted
 with Black before PRs are submitted, otherwise CI will fail. Run the formatter
 with:
 
@@ -391,7 +391,7 @@ make fmt
 ```
 
 [api-keys]: https://dashboard.stripe.com/account/apikeys
-[black]: https://github.com/ambv/black
+[ruff]: https://github.com/astral-sh/ruff
 [connect]: https://stripe.com/connect
 [poetry]: https://github.com/sdispater/poetry
 [stripe-mock]: https://github.com/stripe/stripe-mock

diff --git a/examples/oauth.py b/examples/oauth.py
@@ -33,9 +33,7 @@ def callback():
 <p>Success! Account <code>{stripe_user_id}</code> is connected.</p>
 <p>Click <a href="/deauthorize?stripe_user_id={stripe_user_id}">here</a> to
 disconnect the account.</p>
-""".format(
-        stripe_user_id=resp["stripe_user_id"]
-    )
+""".format(stripe_user_id=resp["stripe_user_id"])
 
 
 @app.route("/deauthorize")
@@ -49,9 +47,7 @@ def deauthorize():
     return """
 <p>Success! Account <code>{stripe_user_id}</code> is disconnected.</p>
 <p>Click <a href="/">here</a> to restart the OAuth flow.</p>
-""".format(
-        stripe_user_id=stripe_user_id
-    )
+""".format(stripe_user_id=stripe_user_id)
 
 
 if __name__ == "__main__":

diff --git a/pyproject.toml b/pyproject.toml
@@ -1,33 +1,18 @@
-[tool.black]
+[tool.ruff]
+# same as our black config
 line-length = 79
-target-version = [
-  "py35",
-  "py36",
-  "py37",
-  "py38",
-  "py39",
-  "py310",
-  #   "py311",  # black 21.12b0 doesn't
-  #   "py312",  # support these targets
-]
-exclude = '''
-/(
-    \.eggs/
-  | \.git/
-  | \.tox/
-  | \.venv/
-  | _build/
-  | build/
-  | dist/
-  | venv/
-)
-'''
+extend-exclude = ["build"]
+
+[tool.ruff.format]
+# currently the default value, but opt-out in the future
+docstring-code-format = false
+
 [tool.pyright]
 include = [
   "stripe",
   "tests/test_generated_examples.py",
   "tests/test_exports.py",
-  "tests/test_http_client.py"
+  "tests/test_http_client.py",
 ]
 exclude = ["build", "**/__pycache__"]
 reportMissingTypeArgument = true

diff --git a/requirements.txt b/requirements.txt
@@ -5,7 +5,7 @@ tox == 4.5.0
 #Virtualenv 20.22.0 dropped support for all Python versions smaller or equal to Python 3.6.
 virtualenv<20.22.0
 pyright == 1.1.336
-black == 22.8.0
+ruff == 0.4.4
 flake8
 mypy == 1.7.0
 

diff --git a/stripe/__init__.py b/stripe/__init__.py
@@ -584,5 +584,4 @@ def __getattr__(name):
 from stripe._webhook_endpoint_service import (
     WebhookEndpointService as WebhookEndpointService,
 )
-
 # The end of the section generated from our OpenAPI spec
diff --git a/stripe/_account.py b/stripe/_account.py
@@ -4179,7 +4179,6 @@ def list(
             params=params,
         )
         if not isinstance(result, ListObject):
-
             raise TypeError(
                 "Expected list object from API, got %s"
                 % (type(result).__name__)
@@ -4200,7 +4199,6 @@ async def list_async(
             params=params,
         )
         if not isinstance(result, ListObject):
-
             raise TypeError(
                 "Expected list object from API, got %s"
                 % (type(result).__name__)
@@ -4497,7 +4495,7 @@ def retrieve_capability(
         cls,
         account: str,
         capability: str,
-        **params: Unpack["Account.RetrieveCapabilityParams"]
+        **params: Unpack["Account.RetrieveCapabilityParams"],
     ) -> "Capability":
         """
         Retrieves information about the specified Account Capability.
@@ -4519,7 +4517,7 @@ async def retrieve_capability_async(
         cls,
         account: str,
         capability: str,
-        **params: Unpack["Account.RetrieveCapabilityParams"]
+        **params: Unpack["Account.RetrieveCapabilityParams"],
     ) -> "Capability":
         """
         Retrieves information about the specified Account Capability.
@@ -4541,7 +4539,7 @@ def modify_capability(
         cls,
         account: str,
         capability: str,
-        **params: Unpack["Account.ModifyCapabilityParams"]
+        **params: Unpack["Account.ModifyCapabilityParams"],
     ) -> "Capability":
         """
         Updates an existing Account Capability. Request or remove a capability by updating its requested parameter.
@@ -4563,7 +4561,7 @@ async def modify_capability_async(
         cls,
         account: str,
         capability: str,
-        **params: Unpack["Account.ModifyCapabilityParams"]
+        **params: Unpack["Account.ModifyCapabilityParams"],
     ) -> "Capability":
         """
         Updates an existing Account Capability. Request or remove a capability by updating its requested parameter.
@@ -4620,7 +4618,7 @@ async def list_capabilities_async(
     def create_external_account(
         cls,
         account: str,
-        **params: Unpack["Account.CreateExternalAccountParams"]
+        **params: Unpack["Account.CreateExternalAccountParams"],
     ) -> Union["BankAccount", "Card"]:
         """
         Create an external account for a given account.
@@ -4640,7 +4638,7 @@ def create_external_account(
     async def create_external_account_async(
         cls,
         account: str,
-        **params: Unpack["Account.CreateExternalAccountParams"]
+        **params: Unpack["Account.CreateExternalAccountParams"],
     ) -> Union["BankAccount", "Card"]:
         """
         Create an external account for a given account.
@@ -4661,7 +4659,7 @@ def retrieve_external_account(
         cls,
         account: str,
         id: str,
-        **params: Unpack["Account.RetrieveExternalAccountParams"]
+        **params: Unpack["Account.RetrieveExternalAccountParams"],
     ) -> Union["BankAccount", "Card"]:
         """
         Retrieve a specified external account for a given account.
@@ -4682,7 +4680,7 @@ async def retrieve_external_account_async(
         cls,
         account: str,
         id: str,
-        **params: Unpack["Account.RetrieveExternalAccountParams"]
+        **params: Unpack["Account.RetrieveExternalAccountParams"],
     ) -> Union["BankAccount", "Card"]:
         """
         Retrieve a specified external account for a given account.
@@ -4703,7 +4701,7 @@ def modify_external_account(
         cls,
         account: str,
         id: str,
-        **params: Unpack["Account.ModifyExternalAccountParams"]
+        **params: Unpack["Account.ModifyExternalAccountParams"],
     ) -> Union["BankAccount", "Card"]:
         """
         Updates the metadata, account holder name, account holder type of a bank account belonging to
@@ -4731,7 +4729,7 @@ async def modify_external_account_async(
         cls,
         account: str,
         id: str,
-        **params: Unpack["Account.ModifyExternalAccountParams"]
+        **params: Unpack["Account.ModifyExternalAccountParams"],
     ) -> Union["BankAccount", "Card"]:
         """
         Updates the metadata, account holder name, account holder type of a bank account belonging to
@@ -4759,7 +4757,7 @@ def delete_external_account(
         cls,
         account: str,
         id: str,
-        **params: Unpack["Account.DeleteExternalAccountParams"]
+        **params: Unpack["Account.DeleteExternalAccountParams"],
     ) -> Union["BankAccount", "Card"]:
         """
         Delete a specified external account for a given account.
@@ -4780,7 +4778,7 @@ async def delete_external_account_async(
         cls,
         account: str,
         id: str,
-        **params: Unpack["Account.DeleteExternalAccountParams"]
+        **params: Unpack["Account.DeleteExternalAccountParams"],
     ) -> Union["BankAccount", "Card"]:
         """
         Delete a specified external account for a given account.
@@ -4800,7 +4798,7 @@ async def delete_external_account_async(
     def list_external_accounts(
         cls,
         account: str,
-        **params: Unpack["Account.ListExternalAccountsParams"]
+        **params: Unpack["Account.ListExternalAccountsParams"],
     ) -> ListObject[Union["BankAccount", "Card"]]:
         """
         List external accounts for an account.
@@ -4820,7 +4818,7 @@ def list_external_accounts(
     async def list_external_accounts_async(
         cls,
         account: str,
-        **params: Unpack["Account.ListExternalAccountsParams"]
+        **params: Unpack["Account.ListExternalAccountsParams"],
     ) -> ListObject[Union["BankAccount", "Card"]]:
         """
         List external accounts for an account.
@@ -4917,7 +4915,7 @@ def retrieve_person(
         cls,
         account: str,
         person: str,
-        **params: Unpack["Account.RetrievePersonParams"]
+        **params: Unpack["Account.RetrievePersonParams"],
     ) -> "Person":
         """
         Retrieves an existing person.
@@ -4938,7 +4936,7 @@ async def retrieve_person_async(
         cls,
         account: str,
         person: str,
-        **params: Unpack["Account.RetrievePersonParams"]
+        **params: Unpack["Account.RetrievePersonParams"],
     ) -> "Person":
         """
         Retrieves an existing person.
@@ -4959,7 +4957,7 @@ def modify_person(
         cls,
         account: str,
         person: str,
-        **params: Unpack["Account.ModifyPersonParams"]
+        **params: Unpack["Account.ModifyPersonParams"],
     ) -> "Person":
         """
         Updates an existing person.
@@ -4980,7 +4978,7 @@ async def modify_person_async(
         cls,
         account: str,
         person: str,
-        **params: Unpack["Account.ModifyPersonParams"]
+        **params: Unpack["Account.ModifyPersonParams"],
     ) -> "Person":
         """
         Updates an existing person.
@@ -5001,7 +4999,7 @@ def delete_person(
         cls,
         account: str,
         person: str,
-        **params: Unpack["Account.DeletePersonParams"]
+        **params: Unpack["Account.DeletePersonParams"],
     ) -> "Person":
         """
         Deletes an existing person's relationship to the account's legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the account_opener. If your integration is using the executive parameter, you cannot delete the only verified executive on file.
@@ -5022,7 +5020,7 @@ async def delete_person_async(
         cls,
         account: str,
         person: str,
-        **params: Unpack["Account.DeletePersonParams"]
+        **params: Unpack["Account.DeletePersonParams"],
     ) -> "Person":
         """
         Deletes an existing person's relationship to the account's legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the account_opener. If your integration is using the executive parameter, you cannot delete the only verified executive on file.

diff --git a/stripe/_account_notice.py b/stripe/_account_notice.py
@@ -175,7 +175,6 @@ def list(
             params=params,
         )
         if not isinstance(result, ListObject):
-
             raise TypeError(
                 "Expected list object from API, got %s"
                 % (type(result).__name__)
@@ -196,7 +195,6 @@ async def list_async(
             params=params,
         )
         if not isinstance(result, ListObject):
-
             raise TypeError(
                 "Expected list object from API, got %s"
                 % (type(result).__name__)

diff --git a/stripe/_api_requestor.py b/stripe/_api_requestor.py
@@ -533,9 +533,9 @@ def _args_for_request_with_retries(
                 generator = MultipartDataGenerator()
                 generator.add_params(params or {})
                 post_data = generator.get_post_data()
-                headers[
-                    "Content-Type"
-                ] = "multipart/form-data; boundary=%s" % (generator.boundary,)
+                headers["Content-Type"] = (
+                    "multipart/form-data; boundary=%s" % (generator.boundary,)
+                )
             else:
                 post_data = encoded_body
         else:

diff --git a/stripe/_apple_pay_domain.py b/stripe/_apple_pay_domain.py
@@ -217,7 +217,6 @@ def list(
             params=params,
         )
         if not isinstance(result, ListObject):
-
             raise TypeError(
                 "Expected list object from API, got %s"
                 % (type(result).__name__)
@@ -238,7 +237,6 @@ async def list_async(
             params=params,
         )
         if not isinstance(result, ListObject):
-
             raise TypeError(
                 "Expected list object from API, got %s"
                 % (type(result).__name__)