Merge pull request #42 from GitGuardian/agateau/spring-cleanup

Spring cleanup

Author: agateau-gg

.github/workflows/test-lint.yml

@@ -15,7 +15,7 @@ jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Set up Python 3.9
         uses: actions/setup-python@v1
         with:
@@ -40,7 +40,7 @@ jobs:
         os: [ubuntu-latest, macos-latest, windows-latest]
         python-version: ['3.7', '3.8', '3.9', '3.10', '3.11']
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v1
         with:
@@ -67,7 +67,7 @@ jobs:
     needs: [lint, build]
     if: github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags')
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
         with:
           fetch-depth: 0
       - name: Set up Python

pygitguardian/client.py

@@ -153,7 +153,7 @@ def __init__(
         self.api_key = api_key
         self.session = session if isinstance(session, Session) else Session()
         self.timeout = timeout
-        self.user_agent = "pygitguardian/{0} ({1};py{2})".format(
+        self.user_agent = "pygitguardian/{} ({};py{})".format(
             self._version, platform.system(), platform.python_version()
         )
 
@@ -163,7 +163,7 @@ def __init__(
         self.session.headers.update(
             {
                 "User-Agent": self.user_agent,
-                "Authorization": "Token {0}".format(api_key),
+                "Authorization": f"Token {api_key}",
             },
         )
 
@@ -334,9 +334,7 @@ def multi_content_scan(
         """
         if len(documents) > MULTI_DOCUMENT_LIMIT:
             raise ValueError(
-                "too many documents submitted for scan (max={0})".format(
-                    MULTI_DOCUMENT_LIMIT
-                )
+                f"too many documents submitted for scan (max={MULTI_DOCUMENT_LIMIT})"
             )
 
         if all(isinstance(doc, dict) for doc in documents):

pygitguardian/models.py

@@ -100,7 +100,7 @@ def __init__(self, document: str, filename: Optional[str] = None, **kwargs: Any)
             self.filename = filename
 
     def __repr__(self) -> str:
-        return "filename:{0}, document:{1}".format(self.filename, self.document)
+        return f"filename:{self.filename}, document:{self.document}"
 
 
 class DetailSchema(BaseSchema):
@@ -134,7 +134,7 @@ def __init__(self, detail: str, **kwargs: Any) -> None:
         self.detail = detail
 
     def __repr__(self) -> str:
-        return "{0}:{1}".format(self.status_code, self.detail)
+        return f"{self.status_code}:{self.detail}"
 
 
 class MatchSchema(BaseSchema):
@@ -185,12 +185,12 @@ def __init__(
 
     def __repr__(self) -> str:
         return (
-            "match:{0}, "
-            "match_type:{1}, "
-            "line_start:{2}, "
-            "line_end:{3}, "
-            "index_start:{4}, "
-            "index_end:{5}".format(
+            "match:{}, "
+            "match_type:{}, "
+            "line_start:{}, "
+            "line_end:{}, "
+            "index_start:{}, "
+            "index_end:{}".format(
                 self.match,
                 self.match_type,
                 repr(self.line_start),
@@ -245,9 +245,9 @@ def is_secret(self) -> bool:
 
     def __repr__(self) -> str:
         return (
-            "break_type:{0}, "
-            "policy:{1}, "
-            "matches: {2}".format(self.break_type, self.policy, repr(self.matches))
+            "break_type:{}, "
+            "policy:{}, "
+            "matches: {}".format(self.break_type, self.policy, repr(self.matches))
         )
 
 
@@ -319,15 +319,15 @@ def has_secrets(self) -> bool:
 
     def __repr__(self) -> str:
         return (
-            "policy_break_count:{0}, "
-            "policies:{1}, "
-            "policy_breaks: {2}".format(
+            "policy_break_count:{}, "
+            "policies:{}, "
+            "policy_breaks: {}".format(
                 self.policy_break_count, self.policies, self.policy_breaks
             )
         )
 
     def __str__(self) -> str:
-        return "{0} policy breaks from the evaluated policies: {1}".format(
+        return "{} policy breaks from the evaluated policies: {}".format(
             self.policy_break_count,
             ", ".join(policy_break.policy for policy_break in self.policy_breaks),
         )
@@ -391,10 +391,10 @@ def has_secrets(self) -> bool:
         return any(scan_result.has_secrets for scan_result in self.scan_results)
 
     def __repr__(self) -> str:
-        return "scan_results:{0}".format(self.scan_results)
+        return f"scan_results:{self.scan_results}"
 
     def __str__(self) -> str:
-        return "{0} scan results containing {1} policy breaks".format(
+        return "{} scan results containing {} policy breaks".format(
             len(self.scan_results),
             len(
                 [
@@ -441,10 +441,10 @@ def __init__(
 
     def __repr__(self) -> str:
         return (
-            "count:{0}, "
-            "limit:{1}, "
-            "remaining:{2}, "
-            "since:{3}".format(
+            "count:{}, "
+            "limit:{}, "
+            "remaining:{}, "
+            "since:{}".format(
                 self.count, self.limit, self.remaining, self.since.isoformat()
             )
         )
@@ -479,7 +479,7 @@ def __init__(self, content: Quota, **kwargs: Any) -> None:
         self.content = content
 
     def __repr__(self) -> str:
-        return "content:{0}".format(repr(self.content))
+        return f"content:{repr(self.content)}"
 
 
 class HealthCheckResponseSchema(BaseSchema):
@@ -508,10 +508,10 @@ def __init__(
 
     def __repr__(self) -> str:
         return (
-            "detail:{0}, "
-            "status_code:{1}, "
-            "app version:{2}, "
-            "secrets engine version:{3}".format(
+            "detail:{}, "
+            "status_code:{}, "
+            "app version:{}, "
+            "secrets engine version:{}".format(
                 self.detail,
                 self.status_code,
                 self.app_version or "",

setup.py

@@ -1,4 +1,3 @@
-import io
 import os
 import re
 
@@ -11,7 +10,7 @@
 
 def read(*args: str) -> str:
     """Reads complete file contents."""
-    return io.open(os.path.join(HERE, *args), encoding="utf-8").read()
+    return open(os.path.join(HERE, *args), encoding="utf-8").read()
 
 
 def get_version() -> str:

tests/test_client.py

@@ -221,7 +221,7 @@ def test_client_creation(
         assert client.api_key == api_key
         assert client.timeout == timeout
         assert user_agent in client.session.headers["User-Agent"]
-        assert client.session.headers["Authorization"] == "Token {0}".format(api_key)
+        assert client.session.headers["Authorization"] == f"Token {api_key}"
 
 
 @pytest.mark.parametrize(
@@ -257,7 +257,7 @@ def test_client__url_from_endpoint(base_uries, version, endpoints_and_urls):
         for endpoint, expected_url in endpoints_and_urls:
             assert (
                 client._url_from_endpoint(endpoint, version) == expected_url
-            ), "Could not get the expected URL for base_uri=`{}`".format(base_uri)
+            ), f"Could not get the expected URL for base_uri=`{base_uri}`"
 
 
 @my_vcr.use_cassette