Python Cheat Sheet

Last update: Dec 30, 2022

Overview

Introduction

Pysheeet was created with intention of collecting python code snippets for reducing coding hours and making life easier and faster. Any contributions are welcome. Please feel free to fork and send a pull request to this project.

What’s New In Python 3

This part only provides a quick glance at some important features in Python 3. If you're interested in all of the most important features, please read the official document, What’s New in Python.

New in Python3

Cheat Sheet

Advanced Cheat Sheet

Appendix

PDF Version

pdf

How to run the server

$ virtualenv venv
$ . venv/bin/activate
$ pip install -r requirements.txt
$ make
$ python app.py

# URL: localhost:5000

Comments

Surround a binary operator with a single space
Surround a binary operator with a single space

PEP8 Reference - Other Recommendations

Always surround these binary operators with a single space on either side: assignment (=), augmented assignment (+=, -= etc.), comparisons (==, <, >, !=, <>, <=, >=, in, not in, is, is not), Booleans (and, or, not).
opened by DemiHwang 4
Bump sphinx from 1.8.5 to 2.0.0
Bumps sphinx from 1.8.5 to 2.0.0.

Changelog

Sourced from sphinx's changelog.

Release 2.0.0 (released Mar 29, 2019)

Dependencies

2.0.0b1

LaTeX builder now depends on TeX Live 2015 or above.

LaTeX builder (with 'pdflatex' :confval:latex_engine) will process Unicode Greek letters in text (not in math mark-up) via the text font and will not escape them to math mark-up. See the discussion of the 'fontenc' key of :confval:latex_elements; such (optional) support for Greek adds, for example on Ubuntu xenial, the texlive-lang-greek and (if default font set-up is not modified) cm-super(-minimal) as additional Sphinx LaTeX requirements.

LaTeX builder with :confval:latex_engine set to 'xelatex' or to 'lualatex' requires (by default) the FreeFont fonts, which in Ubuntu xenial are provided by package fonts-freefont-otf, and e.g. in Fedora 29 via package texlive-gnu-freefont.

requests 2.5.0 or above

The six package is no longer a dependency

The sphinxcontrib-websupport package is no longer a dependency

Some packages are separated to sub packages:

sphinxcontrib.applehelp

sphinxcontrib.devhelp

sphinxcontrib.htmlhelp

sphinxcontrib.jsmath

sphinxcontrib.serializinghtml

sphinxcontrib.qthelp

Incompatible changes

2.0.0b1

Drop python 2.7 and 3.4 support

Drop docutils 0.11 support

Drop features and APIs deprecated in 1.7.x

The default setting for :confval:master_doc is changed to 'index' which has been longly used as default of sphinx-quickstart.

LaTeX: Move message resources to sphinxmessage.sty

LaTeX: Stop using \captions<lang> macro for some labels

LaTeX: for 'xelatex' and 'lualatex', use the FreeFont OpenType fonts as default choice (refs: #5645)

LaTeX: 'xelatex' and 'lualatex' now use \small in code-blocks (due to FreeMono character width) like 'pdflatex' already did (due to Courier character width). You may need to adjust this via :confval:latex_elements 'fvset' key, in case of usage of some other

... (truncated)

Commits

3711c47 Bump to 2.0.0 final

e02af7f Update message catalogs

60e2e89 Merge CHANGES entries

e1185ff Merge pull request #6198 from tk0miya/6196_unexpected_prefix

700be75 Fix #6196: py domain: unexpected prefix is generated

8980f63 Add testcase for sphinx.domains.python

98e4767 Merge pull request #6195 from tk0miya/update_changes

2c75d27 Add an incompatible change entry (refs: #6186)

b96a315 Bump version

987cf55 Bump to 2.0.0 beta2

Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot ignore this [patch|minor|major] version will close this PR and stop Dependabot creating any more for this minor/major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

@dependabot use these labels will set the current labels as the default for future PRs for this repo and language

@dependabot use these reviewers will set the current reviewers as the default for future PRs for this repo and language

@dependabot use these assignees will set the current assignees as the default for future PRs for this repo and language

@dependabot use this milestone will set the current milestone as the default for future PRs for this repo and language

@dependabot badge me will comment on this PR with code to add a "Dependabot enabled" badge to your readme

Additionally, you can set the following in your Dependabot dashboard:

Update frequency (including time of day and day of week)

Automerge options (never/patch/minor, and dev/runtime dependencies)

Pull request limits (per update run and/or open at any time)

Out-of-range updates (receive only lockfile updates, if desired)

Security updates (receive only security updates, if desired)

Finally, you can contact us by mentioning @dependabot.

dependencies
opened by dependabot-preview[bot] 4
make the glossary a bit clearer

in two cases you do g = ... while in once case you want to explain

calling the generator function returns a generator

and in the other you mean

(x for x in seq) is a generator expression evaluating directly to a generator.

i think you should make this clear.

opened by flying-sheep 4
Add example for variable names with multiple words

Regarding https://www.pythonsheets.com/notes/python-basic.html#python-naming-styles.

An example for variable names with compound words would be nice. For example. Should a method local variable be called userName or user_name?

opened by r-mueller 4
Bump docutils from 0.14 to 0.15
Bumps docutils from 0.14 to 0.15.

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot ignore this [patch|minor|major] version will close this PR and stop Dependabot creating any more for this minor/major version (unless you reopen the PR or upgrade to it). To ignore the version in this PR you can just close it

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

@dependabot use these labels will set the current labels as the default for future PRs for this repo and language

@dependabot use these reviewers will set the current reviewers as the default for future PRs for this repo and language

@dependabot use these assignees will set the current assignees as the default for future PRs for this repo and language

@dependabot use this milestone will set the current milestone as the default for future PRs for this repo and language

@dependabot badge me will comment on this PR with code to add a "Dependabot enabled" badge to your readme

Additionally, you can set the following in your Dependabot dashboard:

Update frequency (including time of day and day of week)

Automerge options (never/patch/minor, and dev/runtime dependencies)

Pull request limits (per update run and/or open at any time)

Out-of-range updates (receive only lockfile updates, if desired)

Security updates (receive only security updates, if desired)

Finally, you can contact us by mentioning @dependabot.

dependencies
opened by dependabot-preview[bot] 3
Bump flask from 1.0.3 to 1.1.0
Bumps flask from 1.0.3 to 1.1.0.

Changelog

Sourced from flask's changelog.

Version 1.1.0

Released 2019-07-04

Bump minimum Werkzeug version to >= 0.15.

Drop support for Python 3.4.

Error handlers for InternalServerError or 500 will always be passed an instance of InternalServerError. If they are invoked due to an unhandled exception, that original exception is now available as e.original_exception rather than being passed directly to the handler. The same is true if the handler is for the base HTTPException. This makes error handler behavior more consistent. 3266

Flask.finalize_request is called for all unhandled exceptions even if there is no 500 error handler.

Flask.logger takes the same name as Flask.name (the value passed as Flask(import_name). This reverts 1.0's behavior of always logging to "flask.app", in order to support multiple apps in the same process. A warning will be shown if old configuration is detected that needs to be moved. 2866

flask.RequestContext.copy includes the current session object in the request context copy. This prevents session pointing to an out-of-date object. 2935

Using built-in RequestContext, unprintable Unicode characters in Host header will result in a HTTP 400 response and not HTTP 500 as previously. 2994

send_file supports ~os.PathLike objects as described in PEP 0519, to support pathlib in Python 3. 3059

send_file supports ~io.BytesIO partial content. 2957

open_resource accepts the "rt" file mode. This still does the same thing as "r". 3163

The MethodView.methods attribute set in a base class is used by subclasses. 3138

Flask.jinja_options is a dict instead of an ImmutableDict to allow easier configuration. Changes must still be made before creating the environment. 3190

Flask's JSONMixin for the request and response wrappers was moved into Werkzeug. Use Werkzeug's version with Flask-specific support. This bumps the Werkzeug dependency to >= 0.15. 3125

The flask command entry point is simplified to take advantage of Werkzeug 0.15's better reloader support. This bumps the Werkzeug dependency to >= 0.15. 3022

Support static_url_path that ends with a forward slash. 3134

Support empty static_folder without requiring setting an empty static_url_path as well. 3124

jsonify supports dataclasses.dataclass objects. 3195

Allow customizing the Flask.url_map_class used for routing. 3069

The development server port can be set to 0, which tells the OS to pick an available port. 2926

The return value from cli.load_dotenv is more consistent with the documentation. It will return False if python-dotenv is not installed, or if the given path isn't a file. 2937

Signaling support has a stub for the connect_via method when the Blinker library is not installed. 3208

Add an --extra-files option to the flask run CLI command to specify extra files that will trigger the reloader on change. 2897

Allow returning a dictionary from a view function. Similar to how returning a string will produce a text/html response, returning a dict will call jsonify to produce a application/json response. 3111

Blueprints have a cli Click group like app.cli. CLI commands registered with a blueprint will be available as a group under the flask command. 1357.

When using the test client as a context manager (with client:), all preserved request contexts are popped when the block exits, ensuring nested contexts are cleaned up correctly. 3157

Show a better error message when the view return type is not supported. 3214

flask.testing.make_test_environ_builder() has been deprecated in favour of a new class flask.testing.EnvironBuilder. 3232

The flask run command no longer fails if Python is not built with SSL support. Using the --cert option will show an appropriate error message. 3211

URL matching now occurs after the request context is pushed, rather than when it's created. This allows custom URL converters to access the app and request contexts, such as to query a database for an id. 3088

Version 1.0.4

Released 2019-07-04

The key information for BadRequestKeyError is no longer cleared outside debug mode, so error handlers can still access it. This requires upgrading to Werkzeug 0.15.5. 3249

send_file url quotes the ":" and "/" characters for more compatible UTF-8 filename support in some browsers. 3074

Fixes for PEP451 import loaders and pytest 5.x. 3275

Show message about dotenv on stderr instead of stdout. 3285

Commits

1b4ace9 release version 1.1.0

8a78fdb Merge branch '1.0.x'

626b5cc release version 1.0.4

2844fdb Merge branch '1.0.x'

c074759 Merge pull request #3285 from ThiefMaster/dotenv-msg-stderr

975f979 Move dotenv warning to stderr

6d0e79b Merge pull request #3284 from pallets/logger-warning

b08e35e show warning for old logger config

6665c91 Merge pull request #3282 from pallets/logger-name

df470ae use app.name as app.logger name

Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot ignore this [patch|minor|major] version will close this PR and stop Dependabot creating any more for this minor/major version (unless you reopen the PR or upgrade to it). To ignore the version in this PR you can just close it

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

@dependabot use these labels will set the current labels as the default for future PRs for this repo and language

@dependabot use these reviewers will set the current reviewers as the default for future PRs for this repo and language

@dependabot use these assignees will set the current assignees as the default for future PRs for this repo and language

@dependabot use this milestone will set the current milestone as the default for future PRs for this repo and language

@dependabot badge me will comment on this PR with code to add a "Dependabot enabled" badge to your readme

Additionally, you can set the following in your Dependabot dashboard:

Update frequency (including time of day and day of week)

Automerge options (never/patch/minor, and dev/runtime dependencies)

Pull request limits (per update run and/or open at any time)

Out-of-range updates (receive only lockfile updates, if desired)

Security updates (receive only security updates, if desired)

Finally, you can contact us by mentioning @dependabot.

dependencies
opened by dependabot-preview[bot] 3
DateTime Column is not coded properly

Hi

This page has the following code for the ORM

https://www.pythonsheets.com/notes/python-sqlalchemy.html

class TestTable(Base): __tablename__ = 'Test Table' id = Column(Integer, primary_key=True) key = Column(String, nullable=False) val = Column(String) date = Column(DateTime, default=datetime.utcnow)

The proper way to code the DateTime column is

class TestTable(Base): __tablename__ = 'Test Table' id = Column(Integer, primary_key=True) key = Column(String, nullable=False) val = Column(String) date = Column(DateTime(), default=datetime.utcnow) If you use the code from your example and have two DateTime columns coded this way then SQLalchemy will raise this error on the second column. sqlalchemy.exc.ArgumentError: Column must be constructed with a non-blank name or assign a non-blank .name before adding to a Table.

opened by John-Male 3
Bump bandit from 1.5.1 to 1.6.0
Bumps bandit from 1.5.1 to 1.6.0.

Release notes

Sourced from bandit's releases.

1.6.0

Changelog

Remove paramiko invoke_shell and fix example (#377) @ericwb

Fix custom format argument handling (#380) @evqna

Add release drafter template (#382) @evqna

Add option -q, --quiet, --silent to hide output (#385) @ericwb

Password (#387) @ehooo

Properly handle nosec strings in code (#388) @ericwb

Fix Pylint warning W0612: use of unused variables (#389) @ericwb

No need to skip R0204: redefined-variable-type (#390) @ericwb

Allow failures on dev branch of Python 3.8 (#392) @ericwb

Fix more info line to be in color also (#408) @ericwb

Add pre-commit config (#411) @KPilnacek

Fix B611 doc title (#414) @paulopontesm

Describe baseline and it's usage in README (#415) @BillBrower

Remove unneeded trailing paren in link (#416) @ericwb

Add missing custom formatter doc (#406) (#421) @nixphix

Fix terminal colors not displaying properly on Windows (#424) @GhostofGoes

Fix sql injection check for f-strings (#434) @mikespallino

Bump PyYAML minimum version to 3.13 (#432) @ericwb

Supporting CSafeLoader in yaml.load plugin (#436) @domanchi

Add a readthedocs build status badge (#440) @lukehinds

Fix DeprecationWarning: invalid escape sequence (#441) @BoboTiG

Fix ResourceWarning: unclosed file (#442) @BoboTiG

check if ast.JoinedStr exists before using it (#446) @calvinli

Fix context class (#449) @ehooo

Interpret wildcards in the file exclusion list (#450) @thilp

Fix typo in README (#451) @bitcoinhodler

Redo logo on the README (#463) @ericwb

Remove pycryptodome blacklist (#470) @mikespallino

updated readme links for werkzeug debugger (#473) @soumitr-snowflake

See full changelog

Commits

e5b9037 Redo logo on the README

See full diff in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot ignore this [patch|minor|major] version will close this PR and stop Dependabot creating any more for this minor/major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

@dependabot use these labels will set the current labels as the default for future PRs for this repo and language

@dependabot use these reviewers will set the current reviewers as the default for future PRs for this repo and language

@dependabot use these assignees will set the current assignees as the default for future PRs for this repo and language

@dependabot use this milestone will set the current milestone as the default for future PRs for this repo and language

@dependabot badge me will comment on this PR with code to add a "Dependabot enabled" badge to your readme

Additionally, you can set the following in your Dependabot dashboard:

Update frequency (including time of day and day of week)

Automerge options (never/patch/minor, and dev/runtime dependencies)

Pull request limits (per update run and/or open at any time)

Out-of-range updates (receive only lockfile updates, if desired)

Security updates (receive only security updates, if desired)

Finally, you can contact us by mentioning @dependabot.

dependencies
opened by dependabot-preview[bot] 3
Change to dict and list options
Additional list comprehension option with if/else

slight verbiage change on one entry

additional variable definition in dicts to make sample self-containing
opened by be-rock 3
Bump sphinx from 1.8.1 to 1.8.2
Bumps sphinx from 1.8.1 to 1.8.2.

Changelog

Sourced from sphinx's changelog.

Release 1.8.2 (in development)

Dependencies

Incompatible changes

Deprecated

Features added

Bugs fixed

Testing

Release 1.8.2 (released Nov 11, 2018)

Incompatible changes

#5497: Do not include MathJax.js and jsmath.js unless it is really needed

Features added

#5471: Show appropriate deprecation warnings

Bugs fixed

#5490: latex: enumerated list causes a crash with recommonmark

#5492: sphinx-build fails to build docs w/ Python < 3.5.2

#3704: latex: wrong \label positioning for figures with a legend

#5496: C++, fix assertion when a symbol is declared more than twice.

#5493: gettext: crashed with broken template

#5495: csv-table directive with file option in included file is broken (refs: #4821)

#5498: autodoc: unable to find type hints for a functools.partial

#5480: autodoc: unable to find type hints for unresolvable Forward references

#5419: incompatible math_block node has been generated

#5548: Fix ensuredir() in case of pre-existing file

#5549: graphviz Correctly deal with non-existing static dir

#3002: i18n: multiple footnote_references referring same footnote causes

... (truncated)

Commits

62a83e4 Bump to 1.8.2 final

f75f03c Merge pull request #5601 from tk0miya/tox_install_command

b28ab1e Merge pull request #5600 from tk0miya/3080_invalid_texinfo

8adb20c Give install_command to tox

feba53f Fix #3080: texinfo: multiline citations are broken

84f7812 Fix #3080: texinfo: multiline rubric is broken

994b0ea LaTeX: update date and version of sphinx.sty

c9999b1 Merge pull request #5583 from jfbu/5579_style_index_entries

63daf8c Merge pull request #5525 from eqvinox/revert-pickle-write-1.8

00a75b2 LaTeX: deprecate optional argument scre to visit_index()

Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge

@dependabot reopen will reopen this PR if it is closed

@dependabot ignore this [patch|minor|major] version will close this PR and stop Dependabot creating any more for this minor/major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

@dependabot use these labels will set the current labels as the default for future PRs for this repo and language

@dependabot use these reviewers will set the current reviewers as the default for future PRs for this repo and language

@dependabot use these assignees will set the current assignees as the default for future PRs for this repo and language

@dependabot use this milestone will set the current milestone as the default for future PRs for this repo and language

@dependabot badge me will comment on this PR with code to add a "Dependabot enabled" badge to your readme

Additionally, you can set the following in your Dependabot dashboard:

Update frequency (including time of day and day of week)

Automerge options (never/patch/minor, and dev/runtime dependencies)

Pull request limits (per update run and/or open at any time)

Out-of-range updates (receive only lockfile updates, if desired)

Security updates (receive only security updates, if desired)

Finally, you can contact us by mentioning @dependabot.

dependencies
opened by dependabot-preview[bot] 3
Bump coverage from 4.5.1 to 4.5.2
Bumps coverage from 4.5.1 to 4.5.2.

Commits

See full diff in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge

@dependabot reopen will reopen this PR if it is closed

@dependabot ignore this [patch|minor|major] version will close this PR and stop Dependabot creating any more for this minor/major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

@dependabot use these labels will set the current labels as the default for future PRs for this repo and language

@dependabot use these reviewers will set the current reviewers as the default for future PRs for this repo and language

@dependabot use these assignees will set the current assignees as the default for future PRs for this repo and language

@dependabot use this milestone will set the current milestone as the default for future PRs for this repo and language

@dependabot badge me will comment on this PR with code to add a "Dependabot enabled" badge to your readme

Additionally, you can set the following in your Dependabot dashboard:

Update frequency (including time of day and day of week)

Automerge options (never/patch/minor, and dev/runtime dependencies)

Pull request limits (per update run and/or open at any time)

Out-of-range updates (receive only lockfile updates, if desired)

Security updates (receive only security updates, if desired)

Finally, you can contact us by mentioning @dependabot.

dependencies
opened by dependabot-preview[bot] 3
Bump sphinx from 5.3.0 to 6.0.0
Bumps sphinx from 5.3.0 to 6.0.0.

Release notes

Sourced from sphinx's releases.

v6.0.0

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v6.0.0b2

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v6.0.0b1

Changelog: https://www.sphinx-doc.org/en/master/changes.html

Changelog

Sourced from sphinx's changelog.

Release 6.0.0 (released Dec 29, 2022)

Dependencies

#10468: Drop Python 3.6 support

#10470: Drop Python 3.7, Docutils 0.14, Docutils 0.15, Docutils 0.16, and Docutils 0.17 support. Patch by Adam Turner

Incompatible changes

#7405: Removed the jQuery and underscore.js JavaScript frameworks.

These frameworks are no longer be automatically injected into themes from Sphinx 6.0. If you develop a theme or extension that uses the jQuery, $, or $u global objects, you need to update your JavaScript to modern standards, or use the mitigation below.

The first option is to use the sphinxcontrib.jquery_ extension, which has been developed by the Sphinx team and contributors. To use this, add sphinxcontrib.jquery to the extensions list in conf.py, or call app.setup_extension("sphinxcontrib.jquery") if you develop a Sphinx theme or extension.

The second option is to manually ensure that the frameworks are present. To re-add jQuery and underscore.js, you will need to copy jquery.js and underscore.js from the Sphinx repository_ to your static directory, and add the following to your layout.html:

.. code-block:: html+jinja

{%- block scripts %} {{ super() }} {%- endblock %}

.. _sphinxcontrib.jquery: https://github.com/sphinx-contrib/jquery/

Patch by Adam Turner.

#10471, #10565: Removed deprecated APIs scheduled for removal in Sphinx 6.0. See :ref:dev-deprecated-apis for details. Patch by Adam Turner.

#10901: C Domain: Remove support for parsing pre-v3 style type directives and roles. Also remove associated configuration variables c_allow_pre_v3 and c_warn_on_allowed_pre_v3. Patch by Adam Turner.

Features added

... (truncated)

Commits

5b56a23 Bump to 6.0.0 final

f1d1e9c Update coverage workflow for Tox 4

66a738c Update coverage workflow for new configuration location

041e5f8 Add test coverage for 'today_fmt' reference substitution (#10980)

da25145 Remove unnecessary conditional import in sphinx.ext.napoleon (#11043)

45a0ea9 Migrate coveragepy config into pyproject.toml (#11025)

3ec54f1 Create a pydata_sphinx_theme section in usage examples (#11046)

32bce8f Copy edit the tutorial (#11049)

9844162 Fix example using add_config_value (#10937)

bf4a626 RTD builder: add graphviz depedendency (#11040)

Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

dependencies
opened by dependabot[bot] 0
Bump coverage from 6.5.0 to 7.0.1
Bumps coverage from 6.5.0 to 7.0.1.

Changelog

Sourced from coverage's changelog.

Version 7.0.1 — 2022-12-23

When checking if a file mapping resolved to a file that exists, we weren't considering files in .whl files. This is now fixed, closing issue 1511_.

File pattern rules were too strict, forbidding plus signs and curly braces in directory and file names. This is now fixed, closing issue 1513_.

Unusual Unicode or control characters in source files could prevent reporting. This is now fixed, closing issue 1512_.

The PyPy wheel now installs on PyPy 3.7, 3.8, and 3.9, closing issue 1510_.

.. _issue 1510: nedbat/coveragepy#1510 .. _issue 1511: nedbat/coveragepy#1511 .. _issue 1512: nedbat/coveragepy#1512 .. _issue 1513: nedbat/coveragepy#1513

.. _changes_7-0-0:

Version 7.0.0 — 2022-12-18

Nothing new beyond 7.0.0b1.

.. _changes_7-0-0b1:

Version 7.0.0b1 — 2022-12-03

A number of changes have been made to file path handling, including pattern matching and path remapping with the [paths] setting (see :ref:config_paths). These changes might affect you, and require you to update your settings.

(This release includes the changes from 6.6.0b1 <changes_6-6-0b1_>_, since 6.6.0 was never released.)

Changes to file pattern matching, which might require updating your configuration:

Previously, * would incorrectly match directory separators, making precise matching difficult. This is now fixed, closing issue 1407_.

Now ** matches any number of nested directories, including none.

Improvements to combining data files when using the

... (truncated)

Commits

c5cda3a docs: releases take a little bit longer now

9d4226e docs: latest sample HTML report

8c77758 docs: prep for 7.0.1

da1b282 fix: also look into .whl files for source

d327a70 fix: more information when mapping rules aren't working right.

35e249f fix: certain strange characters caused reporting to fail. #1512

152cdc7 fix: don't forbid plus signs in file names. #1513

31513b4 chore: make upgrade

873b059 test: don't run tests on Windows PyPy-3.9

5c5caa2 build: PyPy wheel now installs on 3.7, 3.8, and 3.9. #1510

Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

dependencies
opened by dependabot[bot] 0
Bump flask from 2.1.3 to 2.2.2
Bumps flask from 2.1.3 to 2.2.2.

Release notes

Sourced from flask's releases.

2.2.2

This is a fix release for the 2.2.0 feature release.

Changes: https://flask.palletsprojects.com/en/2.2.x/changes/#version-2-2-1

Milestone: https://github.com/pallets/flask/milestone/25?closed=1

2.2.1

This is a fix release for the 2.2.0 feature release.

Changes: https://flask.palletsprojects.com/en/2.2.x/changes/#version-2-2-1

Milestone: https://github.com/pallets/flask/milestone/23?closed=1

2.2.0

This is a feature release, which includes new features and removes previously deprecated code. The 2.2.x branch is now the supported bug fix branch, the 2.1.x branch will become a tag marking the end of support for that branch. We encourage everyone to upgrade, and to use a tool such as pip-tools to pin all dependencies and control upgrades.

Changes: https://flask.palletsprojects.com/en/2.2.x/changes/#version-2-2-0

Milestone: https://github.com/pallets/flask/milestone/19?closed=1

Changelog

Sourced from flask's changelog.

Version 2.2.2

Released 2022-08-08

Update Werkzeug dependency to >= 2.2.2. This includes fixes related to the new faster router, header parsing, and the development server. :pr:4754

Fix the default value for app.env to be "production". This attribute remains deprecated. :issue:4740

Version 2.2.1

Released 2022-08-03

Setting or accessing json_encoder or json_decoder raises a deprecation warning. :issue:4732

Version 2.2.0

Released 2022-08-01

Remove previously deprecated code. :pr:4667

Old names for some send_file parameters have been removed. download_name replaces attachment_filename, max_age replaces cache_timeout, and etag replaces add_etags. Additionally, path replaces filename in send_from_directory.

The RequestContext.g property returning AppContext.g is removed.

Update Werkzeug dependency to >= 2.2.

The app and request contexts are managed using Python context vars directly rather than Werkzeug's LocalStack. This should result in better performance and memory use. :pr:4682

Extension maintainers, be aware that _app_ctx_stack.top and _request_ctx_stack.top are deprecated. Store data on g instead using a unique prefix, like g._extension_name_attr.

The FLASK_ENV environment variable and app.env attribute are deprecated, removing the distinction between development and debug mode. Debug mode should be controlled directly using the --debug option or app.run(debug=True). :issue:4714

... (truncated)

Commits

a1c478b Merge pull request #4755 from pallets/release-2.2.2

43d2fff release version 2.2.2

e9af7c2 Merge pull request #4754 from pallets/werkzeug-version

de16718 require werkzeug >= 2.2.2

6ab3cb8 fix issue number

e3eaafb Merge pull request #4749 from pallets/shell-env

e3df233 remove env from shell banner

a0458ef refactor or remove old docs (#4748)

45b2c99 Merge pull request #4742 from pallets/env-default

a6a7a57 fix default value of app.env

Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

dependencies
opened by dependabot[bot] 0
Bump werkzeug from 2.0.3 to 2.2.2
Bumps werkzeug from 2.0.3 to 2.2.2.

Release notes

Sourced from werkzeug's releases.

2.2.2

This is a fix release for the 2.2.0 feature release.

Changes: https://werkzeug.palletsprojects.com/en/2.2.x/changes/#version-2-2-2

Milestone: https://github.com/pallets/werkzeug/milestone/25?closed=1

2.2.1

This is a fix release for the 2.2.0 feature release.

Changes: https://werkzeug.palletsprojects.com/en/2.2.x/changes/#version-2-2-1

Milestone: https://github.com/pallets/werkzeug/milestone/24?closed=1

2.2.0

This is a feature release, which includes new features and removes previously deprecated features. The 2.2.x branch is now the supported bugfix branch, the 2.1.x branch will become a tag marking the end of support for that branch. We encourage everyone to upgrade, and to use a tool such as pip-tools to pin all dependencies and control upgrades.

Changes: https://werkzeug.palletsprojects.com/en/2.2.x/changes/#version-2-2-0

Milestone: https://github.com/pallets/werkzeug/milestone/20?closed=1

2.1.2

This is a fix release for the 2.1.0 feature release.

Changes: https://werkzeug.palletsprojects.com/en/2.1.x/changes/#version-2-1-2

Milestone: https://github.com/pallets/werkzeug/milestone/22?closed=1

2.1.1

This is a fix release for the 2.1.0 feature release.

Changes: https://werkzeug.palletsprojects.com/en/2.1.x/changes/#version-2-1-1

Milestone: https://github.com/pallets/werkzeug/milestone/19?closed=1

2.1.0

This is a feature release, which includes new features and removes previously deprecated features. The 2.1.x branch is now the supported bugfix branch, the 2.0.x branch will become a tag marking the end of support for that branch. We encourage everyone to upgrade, and to use a tool such as pip-tools to pin all dependencies and control upgrades.

Changes: https://werkzeug.palletsprojects.com/en/2.1.x/changes/#version-2-1-0

Milestone: https://github.com/pallets/werkzeug/milestone/16?closed=1

Changelog

Sourced from werkzeug's changelog.

Version 2.2.2

Released 2022-08-08

Fix router to restore the 2.1 strict_slashes == False behaviour whereby leaf-requests match branch rules and vice versa. :pr:2489

Fix router to identify invalid rules rather than hang parsing them, and to correctly parse / within converter arguments. :pr:2489

Update subpackage imports in :mod:werkzeug.routing to use the import as syntax for explicitly re-exporting public attributes. :pr:2493

Parsing of some invalid header characters is more robust. :pr:2494

When starting the development server, a warning not to use it in a production deployment is always shown. :issue:2480

LocalProxy.__wrapped__ is always set to the wrapped object when the proxy is unbound, fixing an issue in doctest that would cause it to fail. :issue:2485

Address one ResourceWarning related to the socket used by run_simple. :issue:2421

Version 2.2.1

Released 2022-07-27

Fix router so that /path/ will match a rule /path if strict slashes mode is disabled for the rule. :issue:2467

Fix router so that partial part matches are not allowed i.e. /2df does not match /<int>. :pr:2470

Fix router static part weighting, so that simpler routes are matched before more complex ones. :issue:2471

Restore ValidationError to be importable from werkzeug.routing. :issue:2465

Version 2.2.0

Released 2022-07-23

Deprecated get_script_name, get_query_string, peek_path_info, pop_path_info, and extract_path_info. :pr:2461

Remove previously deprecated code. :pr:2461

Add MarkupSafe as a dependency and use it to escape values when rendering HTML. :issue:2419

... (truncated)

Commits

15fcb87 Merge pull request #2499 from pallets/release-2.2.2

87b082a release version 2.2.2

110b4cd Merge pull request #2498 from pallets/socket-warning

b484e54 handle unclosed socket resource warning

bebf46d Merge pull request #2497 from pallets/local-wrapped

82d3fba LocalProxy.wrapped is always set when unbound

fe8a56e Merge pull request #2496 from pallets/deploy-docs

1c656e1 modernize deployment docs

67dc99d Merge pull request #2495 from pallets/dev-server-warning

09a3066 always show dev server warning

Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

dependencies
opened by dependabot[bot] 0
Bump bandit from 1.7.2 to 1.7.4
Bumps bandit from 1.7.2 to 1.7.4.

Release notes

Sourced from bandit's releases.

1.7.4

What's Changed

Fix traceback in hashlib_insecure_functions by @ericwb in PyCQA/bandit#834

Add version 1.7.3 to dropdown by @ericwb in PyCQA/bandit#833

core/config: Fix ConfigError missing argument if toml is missing by @Holzhaus in PyCQA/bandit#845

Add 1.7.4 in issue template by @ericwb in PyCQA/bandit#846

New Contributors

@Holzhaus made their first contribution in PyCQA/bandit#845

Full Changelog: https://github.com/PyCQA/bandit/compare/1.7.3...1.7.4

1.7.3

What's Changed

Rely on toml conditionally by @sigmavirus24 in PyCQA/bandit#780

Update issue template with latest versions by @ericwb in PyCQA/bandit#783

Delete release-drafter.yml by @ericwb in PyCQA/bandit#781

Use released version of gh-action-pypi-publish by @ericwb in PyCQA/bandit#784

Update publish-to-pypi.yml by @ericwb in PyCQA/bandit#785

Delete releasenotes directory (more openstack leftovers) by @ericwb in PyCQA/bandit#786

[docs] Add Getting Started chapter (migrate from README) by @bittner in PyCQA/bandit#773

Including CWE information by @julianthome in PyCQA/bandit#613

Removal of the CWEMAP dict by @ericwb in PyCQA/bandit#789

Fix up warnings in output of tox by @ericwb in PyCQA/bandit#793

Avoid printing metrics as float point numbers by @ericwb in PyCQA/bandit#794

Add functional test of snmp_security_check by @ericwb in PyCQA/bandit#791

Disable individual tests by @mikespallino in PyCQA/bandit#597

Change up how CWE is formatted by @ericwb in PyCQA/bandit#788

Check value of usedforsecurity for hashlib by @ericwb in PyCQA/bandit#798

Remove redundant Python 3.6 code by @ericwb in PyCQA/bandit#802

Add new plugin to check use of pyghmi by @ericwb in PyCQA/bandit#803

Check for hardcoded passwords in class attributes by @noliverio in PyCQA/bandit#766

Better hashlib check for Python 3.9 by @ericwb in PyCQA/bandit#805

Fix references to the default branch name by @ericwb in PyCQA/bandit#810

Cleanup the README by @ericwb in PyCQA/bandit#809

Show usage with no arguments by @ericwb in PyCQA/bandit#814

Respect color environment variables if set by @ericwb in PyCQA/bandit#813

Cannot seek stdin on pipe by @tylerwince in PyCQA/bandit#496

Test on operating systems we can support by @ericwb in PyCQA/bandit#804

Fix up some warnings and errors in docs by @ericwb in PyCQA/bandit#817

Fix root doc for readthedocs by @ericwb in PyCQA/bandit#818

Use versioned links to docs by @ericwb in PyCQA/bandit#819

Use CWE link in HTML formatter by @ericwb in PyCQA/bandit#825

Improve performance of linerange by @Krock21rus in PyCQA/bandit#629

Inaccurate message in hashlib check by @ericwb in PyCQA/bandit#827

Target Python >= 3.7 in pre-commit hooks by @mkniewallner in PyCQA/bandit#830

Center the bandit logo in readme by @ericwb in PyCQA/bandit#823

Build of artifact fails if raw directive used by @ericwb in PyCQA/bandit#831

New Contributors

... (truncated)

Commits

1ed7906 Add 1.7.4 in issue template (#846)

71bc67c core/config: Fix ConfigError missing argument if toml is missing (#845)

fcde9b5 Add version 1.7.3 to dropdown (#833)

fbaf2ce Fix traceback in hashlib_insecure_functions (#834)

20a0510 Build of artifact fails if raw directive used (#831)

d8c7e3c Center the bandit logo in readme (#823)

a65ae17 Target Python >= 3.7 in pre-commit hooks (#830)

09a6ace Inaccurate message in hashlib check (#827)

8bad6fa Improve performance of linerange (#629)

528c540 Use CWE link in HTML formatter (#825)

Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

dependencies
opened by dependabot[bot] 0
mapper() func is deprectiated

Per the SQLAlchemy docs, the mapper() function is depreciated. The docs suggest using registry.map_imperatively() to get the same functionality used in pysheeet.

@crazyguitar I'd be happy to open a PR & update the syntax - just be patient with me, as I'm still learning :)

opened by data-djinn 1