feat: make python code prettier (#678)

Author: claudiachua

Makefile

@@ -1,4 +1,4 @@
-.PHONY: clean install analysis test test-install test-docker develop docs docs-install
+.PHONY: clean install analysis test test-install test-docker develop docs docs-install prettier prettier-check
 
 venv:
 	@python --version || (echo "Python is not installed, Python 3.7+"; exit 1);
@@ -22,10 +22,10 @@ analysis:
 	. venv/bin/activate; flake8 --ignore=E123,E126,E128,E501,W391,W291,W293,F401 tests
 	. venv/bin/activate; flake8 --ignore=E402,F401,W391,W291,W293 twilio --max-line-length=300
 
-test: analysis
+test: analysis prettier-check
 	. venv/bin/activate; pytest tests --ignore=tests/cluster
 
-test-with-coverage:
+test-with-coverage: prettier-check
 	. venv/bin/activate; \
   	pytest --cov-config=setup.cfg --cov-report xml --cov=twilio tests --ignore=tests/cluster
 
@@ -56,6 +56,14 @@ clean:
 nopyc:
 	find . -name \*.pyc -delete
 
+prettier:
+	. venv/bin/activate; black .
+	. venv/bin/activate; autoflake --remove-all-unused-imports -i -r --exclude venv .
+
+prettier-check:
+	. venv/bin/activate; black --check .
+	. venv/bin/activate; autoflake --check-diff --quiet --remove-all-unused-imports -r --exclude venv .
+
 API_DEFINITIONS_SHA=$(shell git log --oneline | grep Regenerated | head -n1 | cut -d ' ' -f 5)
 CURRENT_TAG=$(shell expr "${GITHUB_TAG}" : ".*-rc.*" >/dev/null && echo "rc" || echo "latest")
 docker-build:

docs/conf.py

@@ -15,15 +15,16 @@
 #
 import os
 import sys
-sys.path.insert(0, os.path.abspath('..'))
+
+sys.path.insert(0, os.path.abspath(".."))
 from twilio import __version__
 
 
 # -- Project information -----------------------------------------------------
 
-project = 'twilio-python'
-copyright = '2023, Twilio'
-author = 'Twilio'
+project = "twilio-python"
+copyright = "2023, Twilio"
+author = "Twilio"
 
 # The short X.Y version
 version = __version__
@@ -41,28 +42,28 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.doctest',
-    'sphinx.ext.intersphinx',
-    'sphinx.ext.coverage',
-    'sphinx.ext.ifconfig',
-    'sphinx.ext.viewcode',
-    'recommonmark'
+    "sphinx.ext.autodoc",
+    "sphinx.ext.doctest",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.coverage",
+    "sphinx.ext.ifconfig",
+    "sphinx.ext.viewcode",
+    "recommonmark",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['source/_templates']
+templates_path = ["source/_templates"]
 
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 #
 source_suffix = {
-    '.rst': 'restructuredtext',
-    '.md': 'markdown',
+    ".rst": "restructuredtext",
+    ".md": "markdown",
 }
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = "index"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -77,23 +78,23 @@
 exclude_patterns = []
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
 
 
 # -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'alabaster'
+html_theme = "alabaster"
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
 #
 # html_theme_options = {}
 
-html_static_path = ['source/_static']
+html_static_path = ["source/_static"]
 
 # Custom sidebar templates, must be a dictionary that maps document names
 # to template names.
@@ -104,15 +105,20 @@
 # 'searchbox.html']``.
 #
 html_sidebars = {
-    '**': [ 'sidebarintro.html', 'localtoc.html', 'relations.html',
-            'sourcelink.html', 'searchbox.html']
+    "**": [
+        "sidebarintro.html",
+        "localtoc.html",
+        "relations.html",
+        "sourcelink.html",
+        "searchbox.html",
+    ]
 }
 
 
 # -- Options for HTMLHelp output ---------------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'twilio-pythondoc'
+htmlhelp_basename = "twilio-pythondoc"
 
 
 # -- Options for LaTeX output ------------------------------------------------
@@ -121,15 +127,12 @@
     # The paper size ('letterpaper' or 'a4paper').
     #
     # 'papersize': 'letterpaper',
-
     # The font size ('10pt', '11pt' or '12pt').
     #
     # 'pointsize': '10pt',
-
     # Additional stuff for the LaTeX preamble.
     #
     # 'preamble': '',
-
     # Latex figure (float) alignment
     #
     # 'figure_align': 'htbp',
@@ -139,19 +142,21 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'twilio-python.tex', 'twilio-python Documentation',
-     'Twilio', 'manual'),
+    (
+        master_doc,
+        "twilio-python.tex",
+        "twilio-python Documentation",
+        "Twilio",
+        "manual",
+    ),
 ]
 
 
 # -- Options for manual page output ------------------------------------------
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [
-    (master_doc, 'twilio-python', 'twilio-python Documentation',
-     [author], 1)
-]
+man_pages = [(master_doc, "twilio-python", "twilio-python Documentation", [author], 1)]
 
 
 # -- Options for Texinfo output ----------------------------------------------
@@ -160,9 +165,15 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'twilio-python', 'twilio-python Documentation',
-     author, 'twilio-python', 'One line description of project.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "twilio-python",
+        "twilio-python Documentation",
+        author,
+        "twilio-python",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]
 
 
@@ -184,12 +195,12 @@
 # epub_uid = ''
 
 # A list of files that should not be packed into the epub file.
-epub_exclude_files = ['search.html']
+epub_exclude_files = ["search.html"]
 
 
 # -- Extension configuration -------------------------------------------------
 
 # -- Options for intersphinx extension ---------------------------------------
 
 # Example configuration for intersphinx: refer to the Python standard library.
-intersphinx_mapping = {'https://docs.python.org/': None}
+intersphinx_mapping = {"https://docs.python.org/": None}

examples/basic_usage.py

@@ -3,8 +3,8 @@
 from twilio.rest import Client
 from twilio.twiml.voice_response import VoiceResponse
 
-ACCOUNT_SID = os.environ.get('TWILIO_ACCOUNT_SID')
-AUTH_TOKEN = os.environ.get('TWILIO_AUTH_TOKEN')
+ACCOUNT_SID = os.environ.get("TWILIO_ACCOUNT_SID")
+AUTH_TOKEN = os.environ.get("TWILIO_AUTH_TOKEN")
 
 
 def example():
@@ -15,31 +15,31 @@ def example():
 
     # Get all messages
     all_messages = client.messages.list()
-    print('There are {} messages in your account.'.format(len(all_messages)))
+    print("There are {} messages in your account.".format(len(all_messages)))
 
     # Get only last 10 messages...
     some_messages = client.messages.list(limit=10)
-    print('Here are the last 10 messages in your account:')
+    print("Here are the last 10 messages in your account:")
     for m in some_messages:
         print(m)
 
     # Get messages in smaller pages...
     all_messages = client.messages.list(page_size=10)
-    print('There are {} messages in your account.'.format(len(all_messages)))
+    print("There are {} messages in your account.".format(len(all_messages)))
 
-    print('Sending a message...')
-    new_message = client.messages.create(to='XXXX', from_='YYYY', body='Twilio rocks!')
+    print("Sending a message...")
+    new_message = client.messages.create(to="XXXX", from_="YYYY", body="Twilio rocks!")
 
-    print('Making a call...')
-    new_call = client.calls.create(to='XXXX', from_='YYYY', method='GET')
+    print("Making a call...")
+    new_call = client.calls.create(to="XXXX", from_="YYYY", method="GET")
 
-    print('Serving TwiML')
+    print("Serving TwiML")
     twiml_response = VoiceResponse()
-    twiml_response.say('Hello!')
+    twiml_response.say("Hello!")
     twiml_response.hangup()
     twiml_xml = twiml_response.to_xml()
-    print('Generated twiml: {}'.format(twiml_xml))
+    print("Generated twiml: {}".format(twiml_xml))
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     example()

examples/client_validation.py

@@ -6,15 +6,16 @@
     Encoding,
     PublicFormat,
     PrivateFormat,
-    NoEncryption
+    NoEncryption,
 )
 
 from twilio.http.validation_client import ValidationClient
 from twilio.rest import Client
 
 
-ACCOUNT_SID = os.environ.get('TWILIO_ACCOUNT_SID')
-AUTH_TOKEN = os.environ.get('TWILIO_AUTH_TOKEN')
+ACCOUNT_SID = os.environ.get("TWILIO_ACCOUNT_SID")
+AUTH_TOKEN = os.environ.get("TWILIO_AUTH_TOKEN")
+
 
 def example():
     """
@@ -28,45 +29,45 @@ def example():
 
     # Using Client Validation requires using API Keys for auth
     # First create an API key using the standard account sid, auth token client
-    print('Creating new api key...')
-    api_key = client.new_keys.create(friendly_name='ClientValidationApiKey')
+    print("Creating new api key...")
+    api_key = client.new_keys.create(friendly_name="ClientValidationApiKey")
 
     # Generate a new RSA Keypair
-    print('Generating RSA key pair...')
+    print("Generating RSA key pair...")
     key_pair = rsa.generate_private_key(
-        public_exponent=65537,
-        key_size=2048,
-        backend=default_backend()
+        public_exponent=65537, key_size=2048, backend=default_backend()
+    )
+    public_key = key_pair.public_key().public_bytes(
+        Encoding.PEM, PublicFormat.SubjectPublicKeyInfo
+    )
+    private_key = key_pair.private_bytes(
+        Encoding.PEM, PrivateFormat.PKCS8, NoEncryption()
     )
-    public_key = key_pair.public_key().public_bytes(Encoding.PEM, PublicFormat.SubjectPublicKeyInfo)
-    private_key = key_pair.private_bytes(Encoding.PEM, PrivateFormat.PKCS8, NoEncryption())
 
     # Register the public key with Twilio
-    print('Registering public key with Twilio...')
+    print("Registering public key with Twilio...")
     credential = client.accounts.credentials.public_key.create(
-        public_key,
-        friendly_name='ClientValidationPublicKey'
+        public_key, friendly_name="ClientValidationPublicKey"
     )
 
     # Create a new ValidationClient with the keys we created
     validation_client = ValidationClient(
-        ACCOUNT_SID,
-        api_key.sid,
-        credential.sid,
-        private_key
+        ACCOUNT_SID, api_key.sid, credential.sid, private_key
     )
 
     # Create a REST Client using the validation_client
-    client = Client(api_key.sid, api_key.secret, ACCOUNT_SID, http_client=validation_client)
+    client = Client(
+        api_key.sid, api_key.secret, ACCOUNT_SID, http_client=validation_client
+    )
 
     # Use the library as usual
-    print('Trying out client validation...')
+    print("Trying out client validation...")
     messages = client.messages.list(limit=10)
     for m in messages:
-        print('Message {}'.format(m.sid))
+        print("Message {}".format(m.sid))
 
-    print('Client validation works!')
+    print("Client validation works!")
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     example()

setup.py

@@ -1,6 +1,6 @@
 from setuptools import setup, find_packages
 
-with open('README.md') as f:
+with open("README.md") as f:
     long_description = f.read()
 
 # To install the twilio-python library, open a Terminal shell, then run this
@@ -19,16 +19,16 @@
     author_email="help@twilio.com",
     url="https://github.com/twilio/twilio-python/",
     keywords=["twilio", "twiml"],
-    python_requires='>=3.7.0',
+    python_requires=">=3.7.0",
     install_requires=[
         "pytz",
         "requests >= 2.0.0",
         "PyJWT >= 2.0.0, < 3.0.0",
         "asyncio>=3.4.3",
         "aiohttp>=3.8.4",
-        "aiohttp-retry>=2.8.3"
+        "aiohttp-retry>=2.8.3",
     ],
-    packages=find_packages(exclude=['tests', 'tests.*']),
+    packages=find_packages(exclude=["tests", "tests.*"]),
     include_package_data=True,
     classifiers=[
         "Development Status :: 5 - Production/Stable",
@@ -46,5 +46,5 @@
         "Topic :: Communications :: Telephony",
     ],
     long_description=long_description,
-    long_description_content_type='text/markdown'
+    long_description_content_type="text/markdown",
 )