Skip to content

Commit

Permalink
Run black over the project
Browse files Browse the repository at this point in the history
I should have done this a long time ago.
  • Loading branch information
Menno Smits committed Jan 16, 2021
1 parent 7f46447 commit f072340
Show file tree
Hide file tree
Showing 44 changed files with 2,393 additions and 1,860 deletions.
108 changes: 52 additions & 56 deletions doc/src/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,40 +6,40 @@
import sys
from os import path

sys.path.insert(0, path.abspath(path.join(path.dirname(__file__), '..', '..')))
sys.path.insert(0, path.abspath(path.join(path.dirname(__file__), "..", "..")))

import imapclient

# -- General configuration -----------------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'
# needs_sphinx = '1.0'

# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.viewcode',
'sphinx.ext.intersphinx',
"sphinx.ext.autodoc",
"sphinx.ext.viewcode",
"sphinx.ext.intersphinx",
]

intersphinx_mapping = {'python':('http://docs.python.org/3', None)}
intersphinx_mapping = {"python": ("http://docs.python.org/3", None)}

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
templates_path = ["_templates"]

# The suffix of source filenames.
source_suffix = '.rst'
source_suffix = ".rst"

# The encoding of source files.
#source_encoding = 'utf-8-sig'
# source_encoding = 'utf-8-sig'

# The master toctree document.
master_doc = 'index'
master_doc = "index"

# General information about the project.
project = u'IMAPClient'
copyright = u'2014, Menno Smits'
project = u"IMAPClient"
copyright = u"2014, Menno Smits"

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
Expand All @@ -52,71 +52,71 @@

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None
# language = None

# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'
# today_fmt = '%B %d, %Y'

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = []

# The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None
# default_role = None

# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True
# add_function_parentheses = True

# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True
# add_module_names = True

# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False
# show_authors = False

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
pygments_style = "sphinx"

# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
# modindex_common_prefix = []


# -- 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 = 'sphinxdoc'
html_theme = "sphinxdoc"

html_use_modindex = False
html_use_index = False

# 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_theme_options = {}

# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []
# html_theme_path = []

# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
#html_title = None
# html_title = None

# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None
# html_short_title = None

# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None
# html_logo = None

# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#html_favicon = None
# html_favicon = None

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
Expand All @@ -125,93 +125,89 @@

# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y'
# html_last_updated_fmt = '%b %d, %Y'

# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True
# html_use_smartypants = True

# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}
# html_sidebars = {}

# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}
# html_additional_pages = {}

# If false, no module index is generated.
#html_domain_indices = True
# html_domain_indices = True

# If false, no index is generated.
#html_use_index = True
# html_use_index = True

# If true, the index is split into individual pages for each letter.
#html_split_index = False
# html_split_index = False

# If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True
# html_show_sourcelink = True

# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True
# html_show_sphinx = True

# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = True
# html_show_copyright = True

# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''
# html_use_opensearch = ''

# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None
# html_file_suffix = None

# Output file base name for HTML help builder.
htmlhelp_basename = 'IMAPClientdoc'
htmlhelp_basename = "IMAPClientdoc"


# -- Options for LaTeX output --------------------------------------------------

# The paper size ('letter' or 'a4').
#latex_paper_size = 'letter'
# latex_paper_size = 'letter'

# The font size ('10pt', '11pt' or '12pt').
#latex_font_size = '10pt'
# latex_font_size = '10pt'

# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
('index', 'IMAPClient.tex', u'IMAPClient Documentation',
u'Menno Smits', 'manual'),
("index", "IMAPClient.tex", u"IMAPClient Documentation", u"Menno Smits", "manual"),
]

# The name of an image file (relative to this directory) to place at the top of
# the title page.
#latex_logo = None
# latex_logo = None

# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False
# latex_use_parts = False

# If true, show page references after internal links.
#latex_show_pagerefs = False
# latex_show_pagerefs = False

# If true, show URL addresses after external links.
#latex_show_urls = False
# latex_show_urls = False

# Additional stuff for the LaTeX preamble.
#latex_preamble = ''
# latex_preamble = ''

# Documents to append as an appendix to all manuals.
#latex_appendices = []
# latex_appendices = []

# If false, no module index is generated.
#latex_domain_indices = True
# latex_domain_indices = True


# -- Options for manual page output --------------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'imapclient', u'IMAPClient Documentation',
[u'Menno Smits'], 1)
]
man_pages = [("index", "imapclient", u"IMAPClient Documentation", [u"Menno Smits"], 1)]
16 changes: 8 additions & 8 deletions examples/email_parsing.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@

from imapclient import IMAPClient

HOST = 'imap.host.com'
USERNAME = 'someuser'
PASSWORD = 'secret'
HOST = "imap.host.com"
USERNAME = "someuser"
PASSWORD = "secret"

with IMAPClient(HOST) as server:
server.login(USERNAME, PASSWORD)
server.select_folder('INBOX', readonly=True)
server.select_folder("INBOX", readonly=True)

messages = server.search('UNSEEN')
for uid, message_data in server.fetch(messages, 'RFC822').items():
email_message = email.message_from_bytes(message_data[b'RFC822'])
print(uid, email_message.get('From'), email_message.get('Subject'))
messages = server.search("UNSEEN")
for uid, message_data in server.fetch(messages, "RFC822").items():
email_message = email.message_from_bytes(message_data[b"RFC822"])
print(uid, email_message.get("From"), email_message.get("Subject"))
20 changes: 10 additions & 10 deletions examples/example.py
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
from imapclient import IMAPClient

HOST = 'imap.host.com'
USERNAME = 'someuser'
PASSWORD = 'secret'
HOST = "imap.host.com"
USERNAME = "someuser"
PASSWORD = "secret"

server = IMAPClient(HOST)
server.login(USERNAME, PASSWORD)

select_info = server.select_folder('INBOX')
print('%d messages in INBOX' % select_info[b'EXISTS'])
select_info = server.select_folder("INBOX")
print("%d messages in INBOX" % select_info[b"EXISTS"])

messages = server.search(['NOT', 'DELETED'])
messages = server.search(["NOT", "DELETED"])
print("%d messages that aren't deleted\n" % len(messages))

print("Messages:")
response = server.fetch(messages, ['FLAGS', 'RFC822.SIZE'])
response = server.fetch(messages, ["FLAGS", "RFC822.SIZE"])
for msgid, data in response.items():
print(' ID %d: %d bytes, flags=%s' % (msgid,
data[b'RFC822.SIZE'],
data[b'FLAGS']))
print(
" ID %d: %d bytes, flags=%s" % (msgid, data[b"RFC822.SIZE"], data[b"FLAGS"])
)

server.logout()
8 changes: 4 additions & 4 deletions examples/idle_example.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@

from imapclient import IMAPClient

HOST = 'imap.host.com'
USERNAME = 'someuser'
PASSWORD = 'password'
HOST = "imap.host.com"
USERNAME = "someuser"
PASSWORD = "password"

server = IMAPClient(HOST)
server.login(USERNAME, PASSWORD)
server.select_folder('INBOX')
server.select_folder("INBOX")

# Start IDLE mode
server.idle()
Expand Down
6 changes: 3 additions & 3 deletions examples/oauth2_example.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@
from imapclient import IMAPClient

# Populate these with actual values
OAUTH2_USER = '...'
OAUTH2_ACCESS_TOKEN = '...'
OAUTH2_USER = "..."
OAUTH2_ACCESS_TOKEN = "..."

HOST = 'imap.host.com'
HOST = "imap.host.com"
URL = "https://somedomain.com/someuser/imap/"

with IMAPClient(HOST) as server:
Expand Down
6 changes: 3 additions & 3 deletions examples/tls_cacert.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@

from imapclient import IMAPClient

HOST = 'imap.host.com'
USERNAME = 'someuser'
PASSWORD = 'secret'
HOST = "imap.host.com"
USERNAME = "someuser"
PASSWORD = "secret"

ssl_context = ssl.create_default_context(cafile="/path/to/cacert.pem")

Expand Down
6 changes: 3 additions & 3 deletions examples/tls_no_checks.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@

from imapclient import IMAPClient

HOST = 'imap.host.com'
USERNAME = 'someuser'
PASSWORD = 'secret'
HOST = "imap.host.com"
USERNAME = "someuser"
PASSWORD = "secret"

ssl_context = ssl.create_default_context()

Expand Down
Loading

0 comments on commit f072340

Please sign in to comment.