Skip to content

Scheduled monthly dependency update for January#26

Closed
pyup-bot wants to merge 8 commits into
masterfrom
pyup-scheduled-update-2021-01-01
Closed

Scheduled monthly dependency update for January#26
pyup-bot wants to merge 8 commits into
masterfrom
pyup-scheduled-update-2021-01-01

Conversation

@pyup-bot

@pyup-bot pyup-bot commented Jan 1, 2021

Copy link
Copy Markdown
Collaborator

Update PyGithub from 1.43.8 to 1.54.1.

Changelog

1.54.1

-----------------------------------

* Pin pyjwt version (1797) (31a1c007)
* Add pyupgrade to pre-commit configuration (1783) (e113e37d)
* Fix 1731: Incorrect annotation (82c349ce)
* Drop support for Python 3.5 (1770) (63e4fae9)
* Revert "Pin requests to <2.25 as well (1757)" (1763) (a806b523)
* Fix stubs file for Repository (fab682a5)

1.54

-----------------------------------
**Important**

This is the last release that will support Python 3.5.

**Breaking Changes**

The Github.get_installation(integer) method has been removed.
Repository.create_deployment()'s payload parameter is now a dictionary.

**Bug Fixes & Improvements**

* Add support for Check Suites (1764) (6d501b28)
* Add missing preview features of Deployment and Deployment Statuses API (1674) (197e0653)
* Correct typing for Commit.get_comments() (1765) (fcdd9eae)
* Pin requests to <2.25 as well (1757) (d159425f)
* Add Support for Check Runs (1727) (c77c0676)
* Added a method for getting a user by their id (1691) (4cfc9912)
* Fix 1742 - incorrect typehint for `Installation.id` (1743) (546f6495)
* Add WorkflowRun.workflow_id (1737) (78a29a7c)
* Add support for Python 3.9 (1735) (1bb18ab5)
* Added support for the Self-Hosted actions runners API (1684) (24251f4b)
* Fix Branch protection status in the examples (1729) (88800844)
* Filter the DeprecationWarning in Team tests (1728) (23f47539)
* Added get_installations() to Organizations (1695) (b42fb244)
* Fix 1507: Add new Teams: Add or update team repository endpoint (1509) (1c55be51)
* Added support for `Repository.get_workflow_runs` parameters (1682) (c23564dd)
* feat(pullrequest): add the rebaseable attribute (1690) (ee4c7a7e)
* Add support for deleting reactions (1708) (f7d203c0)
* Correct type hint for InputGitTreeElement.sha (08b72b48)
* Ignore new black formatting commit for git blame (1680) (7ec4f155)
* Format with new black (1679) (07e29fe0)
* Add get_timeline() to Issue's type stubs (1663) (6bc9ecc8)

1.53

-----------------------------------

* Test Organization.get_hook() (1660) (2646a98c)
* Add method get_team_membership for user to Team  (1658) (749e8d35)
* Add typing files for OAuth classes (1656) (429fcc73)
* Fix Repository.create_repository_dispatch type signature (1643) (f891bd61)
* PaginatedList's totalCount is 0 if no last page (1641) (69b37b4a)
* Add initial support for Github Apps. (1631) (260558c1)
* Correct **kwargs typing for search_* (1636) (165d995d)
* Add delete_branch_on_merge arg to Repository.edit type stub (1639) (15b5ae0c)
* Fix type stub for MainClass.get_user (1637) (8912be64)
* Add type stub for Repository.create_fork (1638) (de386dfb)
* Correct Repository.create_pull typing harder (1635) (5ad091d0)

1.52

-----------------------------------

* upload_asset with data in memory (1601) (a7786393)
* Make Issue.closed_by nullable (1629) (06dae387)
* Add support for workflow dispatch event (1625) (16850ef1)
* Do not check reaction_type before sending (1592) (136a3e80)
* Various Github Action improvement (1610) (416f2d0f)
* more flexible header splitting (1616) (85e71361)
* Create Dependabot config file (1607) (e272f117)
* Add support for deployment statuses (1588) (048c8a1d)
* Adds the 'twitter_username' attribute to NamedUser. (1585) (079f75a7)
* Create WorkflowRun.timing namedtuple from the dict (1587) (1879518e)
* Add missing properties to PullRequest.pyi (1577) (c84fad81)
* Add support for Workflow Runs (1583) (4fb1d23f)
* More precise typing for Repository.create_pull (1581) (4ed7aaf8)
* Update sphinx-rtd-theme requirement from <0.5 to <0.6 (1563) (f9e4feeb)
* More precise typing for MainClass.get_user() (1575) (3668f866)
* Small documentation correction in Repository.py (1565) (f0f6ec83)
* Remove "api_preview" parameter from type stubs and docstrings
(1559) (cc1b884c)
* Upgrade actions/setup-python to v2 (1555) (6f1640d2)
* Clean up tests for GitReleaseAsset (1546) (925764ad)
* Repository.update_file() content also accepts bytes (1543) (9fb8588b)
* Fix Repository.get_issues stub (1540) (b40b75f8)
* Check all arguments of NamedUser.get_repos() (1532) (69bfc325)
* Correct Workflow typing (1533) (f41c046f)
* Remove RateLimit.rate (1529) (7abf6004)
* PullRequestReview is not a completable object (1528) (19fc43ab)
* Test more attributes (1526) (52ec366b)
* Remove pointless setters in GitReleaseAsset (1527) (1dd1cf9c)
* Drop some unimplemented methods in GitRef (1525) (d4b61311)
* Remove unneeded duplicate string checks in Branch (1524) (61b61092)
* Turn on coverage reporting for codecov (1522) (e79b9013)
* Drastically increase coverage by checking repr() (1521) (291c4630)
* Fixed formatting of docstrings for `Repository.create_git_tag_and_release()`
and `StatsPunchCard`. (1520) (ce400bc7)
* Remove Repository.topics (1505) (53d58d2b)
* Small improvements to typing (1517) (7b20b13d)
* Correct Repository.get_workflows() (1518) (8727003f)
* docs(repository): correct releases link (1514) (f7cc534d)
* correct Repository.stargazers_count return type to int (1513) (b5737d41)
* Fix two RST warnings in Webhook.rst (1512) (5a8bc203)
* Filter FutureWarning for 2 test cases (1510) (09a1d9e4)
* Raise a FutureWarning on use of client_{id,secret} (1506) (2475fa66)
* Improve type signature for create_from_raw_data (1503) (c7b5eff0)
* feat(column): move, edit and delete project columns (1497) (a32a8965)
* Add support for Workflows (1496) (a1ed7c0e)
* Add create_repository_dispatch to typing files (1502) (ba9d59c2)
* Add OAuth support for GitHub applications (4b437110)
* Create AccessToken entity (4a6468aa)
* Extend installation attributes (61808da1)

1.51

-----------------------------------

* Type stubs are now packaged with the build (1489) (6eba4506)
* Travis CI is now dropped in favor of Github workflow (1488) (d6e77ba1)
* Get the project column by id (1466) (63855409)

1.50

-----------------------------------
**New features**

* PyGithub now supports type checking thanks to (1231) (91433fe9)
* Slack is now the main channel of communication rather than Gitter (6a6e7c26)
* Ability to retrieve public events (1481) (5cf9950b)
* Add and handle the maintainer_can_modify attribute in PullRequest (1465) (e0997b43)
* List matching references (1471) (d3bc6a5c)
* Add create_repository_dispatch (1449) (edcbdfda)
* Add some Organization and Repository attributes. (1468) (3ab97d61)
* Add create project method (801ea385)

**Bug Fixes & Improvements**

* Drop use of shadow-cat for draft PRs (1469) (84bb69ab)
* AuthenticatedUser.get_organization_membership() should be str (1473) (38b34db5)
* Drop documentation for len() of PaginatedList (1470) (70462598)
* Fix param name of projectcard's move function (1451) (bafc4efc)
* Correct typos found with codespell (1467) (83bef0f7)
* Export IncompletableObject in the github namespace (1450) (0ebdbb26)
* Add GitHub Action workflow for checks (1464) (f1401c15)
* Drop unneeded ignore rule for flake8 (1454) (b4ca9177)
* Use pytest to parametrize tests (1438) (d2e9bd69)

1.47

-----------------------------------
**Bug Fixes & Improvements**

* Add support to edit and delete a project (1434) (f11f7395)
* Add method for fetching pull requests associated with a commit (1433) (0c55381b)
* Add "get_repo_permission" to Team class (1416) (219bde53)
* Add list projects support, update tests (1431) (e44d11d5)
* Don't transform completely in PullRequest.*assignees (1428) (b1c35499)
* Add create_project support, add tests (1429) (bf62f752)
* Add draft attribute, update test (bd285248)
* Docstring for Repository.create_git_tag_and_release (1425) (bfeacded)
* Create a tox docs environment (1426) (b30c09aa)
* Add Deployments API (1424) (3d93ee1c)
* Add support for editing project cards (1418) (425280ce)
* Add draft flag parameter, update tests (bd0211eb)
* Switch to using pytest (1423) (c822dd1c)
* Fix GitMembership with a hammer (1420) (f2939eb7)
* Add support to reply to a Pull request comment (1374) (1c82573d)
* PullRequest.update_branch(): allow expected_head_sha to be empty (1412) (806130e9)
* Implement ProjectCard.delete() (1417) (aeb27b78)
* Add pre-commit plugin for black/isort/flake8 (1398) (08b1c474)
* Add tox (1388) (125536fe)
* Open file in text mode in scripts/add_attribute.py (1396) (0396a493)
* Silence most ResourceWarnings (1393) (dd31a706)
* Assert more attributes in Membership (1391) (d6dee016)
* Assert on changed Repository attributes (1390) (6e3ceb19)
* Add reset to the repr for Rate (1389) (0829af81)

1.46

-----------------------------------
**Important**

Python 2 support has been removed. If you still require Python 2, use 1.45.

**Bug Fixes & Improvements**

* Add repo edit support for delete_branch_on_merge (1381) (9564cd4d)
* Fix mistake in Repository.create_fork() (1383) (ad040baf)
* Correct two attributes in Invitation (1382) (882fe087)
* Search repo issues by string label (1379) (4ae1a1e5)
* Correct Repository.create_git_tag_and_release() (1362) (ead565ad)
* exposed seats and filled_seats for Github Organization Plan (1360) (06a300ae)
* Repository.create_project() body is optional (1359) (0e09983d)
* Implement move action for ProjectCard (1356) (b11add41)
* Tidy up ProjectCard.get_content() (1355) (dd80a6c0)
* Added nested teams and parent (1348) (eacabb2f)
* Correct parameter for Label.edit (1350) (16e5f989)
* doc: example of Pull Request creation (1344) (d5ad09ae)
* Fix PyPI wheel deployment (1330) (4561930b)

1.45

-----------------------------------
**Important**

* This is the last release of PyGithub that will support Python 2.

**Breaking Changes**

* Branch.edit_{user,team}_push_restrictions() have been removed
* The new API is:
- Branch.add_{user,team}_push_restrictions() to add new members
- Branch.replace_{user,team}_push_restrictions() to replace all members
- Branch.remove_{user,team}_push_restrictions() to remove members
* The api_preview parameter to Github() has been removed.

**Bug Fixes & Improvements**

* Allow sha=None for InputGitTreeElement (1327) (60464f65)
* Support github timeline events. (1302) (732fd26a)
* Update link to GitHub Enterprise in README (1324) (e1537f79)
* Cleanup travis config (1322) (8189a538)
* Add support for update branch  (1317) (baddb719)
* Refactor Logging tests (1315) (b0ef1909)
* Fix rtd build (b797cac0)
* Add .git-blame-ignore-revs (573c674b)
* Apply black to whole codebase (1303) (6ceb9e9a)
* Fix class used returning pull request comments (1307) (f8e33620)
* Support for create_fork (1306) (2ad51f35)
* Use Repository.get_contents() in tests (1301) (e40768e0)
* Allow GithubObject.update() to be passed headers (1300) (989b635e)
* Correct URL for assignees on PRs (1296) (3170cafc)
* Use inclusive ordered comparison for 'parameterized' requirement (1281) (fb19d2f2)
* Deprecate Repository.get_dir_contents() (1285) (21e89ff1)
* Apply some polish to manage.sh (1284) (3a723252)

1.44.1

-----------------------------------

* Add Python 3.8 to classifiers list (1280) (fec6034a)
* Expand Topic class and add test coverage (1252) (ac682742)
* Add support for team discussions (1246) (1249) (ec3c8d7b)
* Correct API for NamedUser.get_organization_membership (1277) (077c80ba)
* Correct header check for 2FA required (1274) (6ad592b1)
* Use replay framework for Issue142 test (1271) (4d258d93)
* Sync httpretty version requirement with setup.py (1265) (99d38468)
* Handle unicode strings when recording responses (1253) (1254) (faa1bbd6)
* Add assignee removal/addition support to PRs (1241) (a163ba15)
* Check if the version is empty in manage.sh (1268) (db294837)
* Encode content for {create,update}_file (1267) (bc225f9d)
* Update changes.rst (1263) (d7947d82)

1.44

-----------------------------------
**New features**

* This version supports running under Python 3 directly, and the test suite
passes under both 2.7 and recent 3.x's.

**Bug Fixes & Improvements**

* Stop ignoring unused imports and remove them (1250) (a0765083)
* Bump httpretty to be a greater or equal to (1262) (27092fb0)
* Add close all issues example (1256) (13e2c7c7)
* Add six to install_requires (1245) (a840a906)
* Implemented user organization membership. Added test case. (1237) (e50420f7)
* Create DEPLOY.md (c9ed82b2)
* Support non-default URLs in GithubIntegration (1229) (e33858a3)
* Cleanup try/except import in PaginatedList (1228) (89c967bb)
* Add an IncompletableObject exception (1227) (f91cbac2)
* Fix redundant int checks (1226) (850da5af)
* Jump from notifications to related PRs/issues. (1168) (020fbebc)
* Code review bodies are optional in some cases. (1169) (b84d9b19)
* Update changes.rst (1223) (2df7269a)
* Do not auto-close issues with high priority tag (ab27ba4d)
* Fix bug in repository create new file example PyGithub1210 (1211) (74cd6856)
* Remove more Python version specific code (1193) (a0f01cf9)
* Drop use of assertEquals (1194) (7bac694a)
* Fix PR review creation. (1184) (e90cdab0)
* Add support to vulnerability alert and automated security fixes APIs (1195) (8abd50e2)
* Delete Legacy submodule (1192) (7ddb657d)
* Remove some uses of atLeastPython3 (1191) (cca8e3a5)
* Run flake8 in Travis (1163) (f93207b4)
* Fix directories for coverage in Travis (1190) (657f87b5)
* Switch to using six (1189) (dc2f2ad8)
* Update Repository.update_file() docstring (1186) (f1ae7200)
* Correct return type of MainClass.get_organizations (1179) (6e79d270)
* Add cryptography to test-requirements.txt (1165) (9b1c1e09)
Links

Update setuptools from 41.2.0 to 51.1.1.

Changelog

51.1.1

-------


Misc
^^^^
* 2525: Avoid hitting network during test_virtualenv.test_test_command.

51.1.0

-------


Changes
^^^^^^^
* 2486: Project adopts jaraco/skeleton for shared package maintenance.

Misc
^^^^
* 2477: Restore inclusion of rst files in sdist.
* 2484: Setuptools has replaced the master branch with the main branch.
* 2485: Fixed failing test when pip 20.3+ is present.
-- by :user:`yan12125`
* 2487: Fix tests with pytest 6.2
-- by :user:`yan12125`

51.0.0

-------


Breaking Changes
^^^^^^^^^^^^^^^^
* 2435: Require Python 3.6 or later.

Documentation changes
^^^^^^^^^^^^^^^^^^^^^
* 2430: Fixed inconsistent RST title nesting levels caused by 2399
-- by :user:`webknjaz`
* 2430: Fixed a typo in Sphinx docs that made docs dev section disappear
as a result of PR 2426 -- by :user:`webknjaz`

Misc
^^^^
* 2471: Removed the tests that guarantee that the vendored dependencies can be built by distutils.

50.3.2

-------



Documentation changes
^^^^^^^^^^^^^^^^^^^^^
* 2394: Extended towncrier news template to include change note categories.
This allows to see what types of changes a given version introduces
-- by :user:`webknjaz`
* 2427: Started enforcing strict syntax and reference validation
in the Sphinx docs -- by :user:`webknjaz`
* 2428: Removed redundant Sphinx ``Makefile`` support -- by :user:`webknjaz`

Misc
^^^^
* 2401: Enabled test results reporting in AppVeyor CI
-- by :user:`webknjaz`
* 2420: Replace Python 3.9.0 beta with 3.9.0 final on GitHub Actions.
* 2421: Python 3.9 Trove classifier got added to the dist metadata
-- by :user:`webknjaz`

50.3.1

-------



Documentation changes
^^^^^^^^^^^^^^^^^^^^^
* 2093: Finalized doc revamp.
* 2097: doc: simplify index and group deprecated files
* 2102: doc overhaul step 2: break main doc into multiple sections
* 2111: doc overhaul step 3: update userguide
* 2395: Added a ``:user:`` role to Sphinx config -- by :user:`webknjaz`
* 2395: Added an illustrative explanation about the change notes to fragments dir -- by :user:`webknjaz`

Misc
^^^^
* 2379: Travis CI test suite now tests against PPC64.
* 2413: Suppress EOF errors (and other exceptions) when importing lib2to3.

50.3.0

-------



Changes
^^^^^^^
* 2368: In distutils, restore support for monkeypatched CCompiler.spawn per pypa/distutils15.

50.2.0

-------



Changes
^^^^^^^
* 2355: When pip is imported as part of a build, leave distutils patched.
* 2380: There are some setuptools specific changes in the
``setuptools.command.bdist_rpm`` module that are no longer needed, because
they are part of the ``bdist_rpm`` module in distutils in Python
3.5.0. Therefore, code was removed from ``setuptools.command.bdist_rpm``.

50.1.0

-------



Changes
^^^^^^^
* 2350: Setuptools reverts using the included distutils by default. Platform maintainers and system integrators and others are *strongly* encouraged to set ``SETUPTOOLS_USE_DISTUTILS=local`` to help identify and work through the reported issues with distutils adoption, mainly to file issues and pull requests with pypa/distutils such that distutils performs as needed across every supported environment.

50.0.3

-------



Misc
^^^^
* 2363: Restore link_libpython support on Python 3.7 and earlier (see pypa/distutils9).

50.0.2

-------



Misc
^^^^
* 2352: In distutils hack, use absolute import rather than relative to avoid bpo-30876.

50.0.1

-------



Misc
^^^^
* 2357: Restored Python 3.5 support in distutils.util for missing ``subprocess._optim_args_from_interpreter_flags``.
* 2358: Restored AIX support on Python 3.8 and earlier.
* 2361: Add Python 3.10 support to _distutils_hack. Get the 'Loader' abstract class
from importlib.abc rather than importlib.util.abc (alias removed in Python
3.10).

50.0.0

-------



Breaking Changes
^^^^^^^^^^^^^^^^
* 2232: Once again, Setuptools overrides the stdlib distutils on import. For environments or invocations where this behavior is undesirable, users are provided with a temporary escape hatch. If the environment variable ``SETUPTOOLS_USE_DISTUTILS`` is set to ``stdlib``, Setuptools will fall back to the legacy behavior. Use of this escape hatch is discouraged, but it is provided to ease the transition while proper fixes for edge cases can be addressed.

Changes
^^^^^^^
* 2334: In MSVC module, refine text in error message.

49.6.0

-------



Changes
^^^^^^^
* 2129: In pkg_resources, no longer detect any pathname ending in .egg as a Python egg. Now the path must be an unpacked egg or a zip file.

49.5.0

-------



Changes
^^^^^^^
* 2306: When running as a PEP 517 backend, setuptools does not try to install
``setup_requires`` itself. They are reported as build requirements for the
frontend to install.

49.4.0

-------



Changes
^^^^^^^
* 2310: Updated vendored packaging version to 20.4.

49.3.2

-------



Documentation changes
^^^^^^^^^^^^^^^^^^^^^
* 2300: Improve the ``safe_version`` function documentation

Misc
^^^^
* 2297: Once again, in stubs prefer exec_module to the deprecated load_module.

49.3.1

-------



Changes
^^^^^^^
* 2316: Removed warning when ``distutils`` is imported before ``setuptools`` when ``distutils`` replacement is not enabled.

49.3.0

-------



Changes
^^^^^^^
* 2259: Setuptools now provides a .pth file (except for editable installs of setuptools) to the target environment to ensure that when enabled, the setuptools-provided distutils is preferred before setuptools has been imported (and even if setuptools is never imported). Honors the SETUPTOOLS_USE_DISTUTILS environment variable.

49.2.1

-------



Misc
^^^^
* 2257: Fixed two flaws in distutils._msvccompiler.MSVCCompiler.spawn.

49.2.0

-------



Changes
^^^^^^^
* 2230: Now warn the user when setuptools is imported after distutils modules have been loaded (exempting PyPy for 3.6), directing the users of packages to import setuptools first.

49.1.3

-------



Misc
^^^^
* 2212: (Distutils) Allow spawn to accept environment. Avoid monkey-patching global state.
* 2249: Fix extension loading technique in stubs.

49.1.2

-------



Changes
^^^^^^^
* 2232: In preparation for re-enabling a local copy of distutils, Setuptools now honors an environment variable, SETUPTOOLS_USE_DISTUTILS. If set to 'stdlib' (current default), distutils will be used from the standard library. If set to 'local' (default in a imminent backward-incompatible release), the local copy of distutils will be used.

49.1.1

-------



Misc
^^^^
* 2094: Removed pkg_resources.py2_warn module, which is no longer reachable.

49.1.0

-------



Changes
^^^^^^^
* 2228: Disabled distutils adoption for now while emergent issues are addressed.

49.0.1

-------



Misc
^^^^
* 2228: Applied fix for pypa/distutils3, restoring expectation that spawn will raise a DistutilsExecError when attempting to execute a missing file.

49.0.0

-------



Breaking Changes
^^^^^^^^^^^^^^^^
* 2165: Setuptools no longer installs a site.py file during easy_install or develop installs. As a result, .eggs on PYTHONPATH will no longer take precedence over other packages on sys.path. If this issue affects your production environment, please reach out to the maintainers at 2165.

Changes
^^^^^^^
* 2137: Removed (private) pkg_resources.RequirementParseError, now replaced by packaging.requirements.InvalidRequirement. Kept the name for compatibility, but users should catch InvalidRequirement instead.
* 2180: Update vendored packaging in pkg_resources to 19.2.

Misc
^^^^
* 2199: Fix exception causes all over the codebase by using ``raise new_exception from old_exception``

48.0.0

-------



Breaking Changes
^^^^^^^^^^^^^^^^
* 2143: Setuptools adopts distutils from the Python 3.9 standard library and no longer depends on distutils in the standard library. When importing ``setuptools`` or ``setuptools.distutils_patch``, Setuptools will expose its bundled version as a top-level ``distutils`` package (and unload any previously-imported top-level distutils package), retaining the expectation that ``distutils``' objects are actually Setuptools objects.
To avoid getting any legacy behavior from the standard library, projects are advised to always "import setuptools" prior to importing anything from distutils. This behavior happens by default when using ``pip install`` or ``pep517.build``. Workflows that rely on ``setup.py (anything)`` will need to first ensure setuptools is imported. One way to achieve this behavior without modifying code is to invoke Python thus: ``python -c "import setuptools; exec(open('setup.py').read())" (anything)``.

47.3.2

-------



Misc
^^^^
* 2071: Replaced references to the deprecated imp package with references to importlib

47.3.1

-------



Misc
^^^^
* 1973: Removed ``pkg_resources.py31compat.makedirs`` in favor of the stdlib. Use ``os.makedirs()`` instead.
* 2198: Restore ``__requires__`` directive in easy-install wrapper scripts.

47.3.0

-------



Changes
^^^^^^^
* 2197: Console script wrapper for editable installs now has a unified template and honors importlib_metadata if present for faster script execution on older Pythons.

Misc
^^^^
* 2195: Fix broken entry points generated by easy-install (pip editable installs).

47.2.0

-------



Changes
^^^^^^^
* 2194: Editable-installed entry points now load significantly faster on Python versions 3.8+.
* 1471: Incidentally fixed by 2194 on Python 3.8 or when importlib_metadata is present.

47.1.1

-------



Documentation changes
^^^^^^^^^^^^^^^^^^^^^
* 2156: Update mailing list pointer in developer docs

47.1.0

-------



Changes
^^^^^^^
* 2070: In wheel-to-egg conversion, use simple pkg_resources-style namespace declaration for packages that declare namespace_packages.

47.0.0

-------



Breaking Changes
^^^^^^^^^^^^^^^^
* 2094: Setuptools now actively crashes under Python 2. Python 3.5 or later is required. Users of Python 2 should use ``setuptools<45``.

Changes
^^^^^^^
* 1700: Document all supported keywords by migrating the ones from distutils.

46.4.0

-------



Changes
^^^^^^^
* 1753: ``attr:`` now extracts variables through rudimentary examination of the AST,
thereby supporting modules with third-party imports. If examining the AST
fails to find the variable, ``attr:`` falls back to the old behavior of
importing the module. Works on Python 3 only.

46.3.1

-------

No significant changes.

46.3.0

-------



Changes
^^^^^^^
* 2089: Package index functionality no longer attempts to remove an md5 fragment from the index URL. This functionality, added for distribute 163 is no longer relevant.

Misc
^^^^
* 2041: Preserve file modes during pkg files copying, but clear read only flag for target afterwards.
* 2105: Filter ``2to3`` deprecation warnings from ``TestDevelop.test_2to3_user_mode``.

46.2.0

-------



Changes
^^^^^^^
* 2040: Deprecated the ``bdist_wininst`` command. Binary packages should be built as wheels instead.
* 2062: Change 'Mac OS X' to 'macOS' in code.
* 2075: Stop recognizing files ending with ``.dist-info`` as distribution metadata.
* 2086: Deprecate 'use_2to3' functionality. Packagers are encouraged to use single-source solutions or build tool chains to manage conversions outside of setuptools.

Documentation changes
^^^^^^^^^^^^^^^^^^^^^
* 1698: Added documentation for ``build_meta`` (a bare minimum, not completed).

Misc
^^^^
* 2082: Filter ``lib2to3`` ``PendingDeprecationWarning`` and ``DeprecationWarning`` in tests,
because ``lib2to3`` is `deprecated in Python 3.9 <https://bugs.python.org/issue40360>`_.

46.1.3

-------

No significant changes.

46.1.2

-------



Misc
^^^^
* 1458: Added template for reporting Python 2 incompatibilities.

46.1.1

-------

No significant changes.

46.1.0

-------



Changes
^^^^^^^
* 308: Allow version number normalization to be bypassed by wrapping in a 'setuptools.sic()' call.
* 1424: Prevent keeping files mode for package_data build. It may break a build if user's package data has read only flag.
* 1431: In ``easy_install.check_site_dir``, ensure the installation directory exists.
* 1563: In ``pkg_resources`` prefer ``find_spec`` (PEP 451) to ``find_module``.

46.0.0

-------



Breaking Changes
^^^^^^^^^^^^^^^^
* 65: Once again as in 3.0, removed the Features feature.

Changes
^^^^^^^
* 1890: Fix vendored dependencies so importing ``setuptools.extern.some_module`` gives the same object as ``setuptools._vendor.some_module``. This makes Metadata picklable again.
* 1899: Test suite now fails on warnings.

Documentation changes
^^^^^^^^^^^^^^^^^^^^^
* 2011: Fix broken link to distutils docs on package_data

Misc
^^^^
* 1991: Include pkg_resources test data in sdist, so tests can be executed from it.

45.3.0

-------



Changes
^^^^^^^
* 1557: Deprecated eggsecutable scripts and updated docs.
* 1904: Update msvc.py to use CPython 3.8.0 mechanism to find msvc 14+

45.2.0

-------



Changes
^^^^^^^
* 1905: Fixed defect in _imp, introduced in 41.6.0 when the 'tests' directory is not present.
* 1941: Improve editable installs with PEP 518 build isolation:

* The ``--user`` option is now always available. A warning is issued if the user site directory is not available.
* The error shown when the install directory is not in ``PYTHONPATH`` has been turned into a warning.
* 1981: Setuptools now declares its ``tests`` and ``docs`` dependencies in metadata (extras).
* 1985: Add support for installing scripts in environments where bdist_wininst is missing (i.e. Python 3.9).

Misc
^^^^
* 1968: Add flake8-2020 to check for misuse of sys.version or sys.version_info.

45.1.0

-------



Changes
^^^^^^^
* 1458: Add minimum sunset date and preamble to Python 2 warning.
* 1704: Set sys.argv[0] in setup script run by build_meta.__legacy__
* 1974: Add Python 3 Only Trove Classifier and remove universal wheel declaration for more complete transition from Python 2.

45.0.0

-------



Breaking Changes
^^^^^^^^^^^^^^^^
* 1458: Drop support for Python 2. Setuptools now requires Python 3.5 or later. Install setuptools using pip >=9 or pin to Setuptools <45 to maintain 2.7 support.

Changes
^^^^^^^
* 1959: Fix for Python 4: replace unsafe six.PY3 with six.PY2

44.1.1

-------



Misc
^^^^
* 2158: Avoid loading working set during ``Distribution.finalize_options`` prior to invoking ``_install_setup_requires``, broken since v42.0.0.

44.1.0

-------



Changes
^^^^^^^
* 1704: Set sys.argv[0] in setup script run by build_meta.__legacy__
* 1959: Fix for Python 4: replace unsafe six.PY3 with six.PY2
* 1994: Fixed a bug in the "setuptools.finalize_distribution_options" hook that lead to ignoring the order attribute of entry points managed by this hook.

44.0.0

-------



Breaking Changes
^^^^^^^^^^^^^^^^
* 1908: Drop support for Python 3.4.

43.0.0

-------



Breaking Changes
^^^^^^^^^^^^^^^^
* 1634: Include ``pyproject.toml`` in source distribution by default. Projects relying on the previous behavior where ``pyproject.toml`` was excluded by default should stop relying on that behavior or add ``exclude pyproject.toml`` to their MANIFEST.in file.

Changes
^^^^^^^
* 1927: Setuptools once again declares 'setuptools' in the ``build-system.requires`` and adds PEP 517 build support by declaring itself as the ``build-backend``. It additionally specifies ``build-system.backend-path`` to rely on itself for those builders that support it.

42.0.2

-------

Changes
^^^^^^^

* 1921: Fix support for easy_install's ``find-links`` option in ``setup.cfg``.
* 1922: Build dependencies (setup_requires and tests_require) now install transitive dependencies indicated by extras.

42.0.1

-------



Changes
^^^^^^^
* 1918: Fix regression in handling wheels compatibility tags.

42.0.0

-------



Breaking Changes
^^^^^^^^^^^^^^^^
* 1830, 1909: Mark the easy_install script and setuptools command as deprecated, and use `pip <https://pip.pypa.io/en/stable/>`_ when available to fetch/build wheels for missing ``setup_requires``/``tests_require`` requirements, with the following differences in behavior:
* support for ``python_requires``
* better support for wheels (proper handling of priority with respect to PEP 425 tags)
* PEP 517/518 support
* eggs are not supported
* no support for the ``allow_hosts`` easy_install option (``index_url``/``find_links`` are still honored)
* pip environment variables are honored (and take precedence over easy_install options)
* 1898: Removed the "upload" and "register" commands in favor of `twine <https://pypi.org/p/twine>`_.

Changes
^^^^^^^
* 1767: Add support for the ``license_files`` option in ``setup.cfg`` to automatically
include multiple license files in a source distribution.
* 1829: Update handling of wheels compatibility tags:
* add support for manylinux2010
* fix use of removed 'm' ABI flag in Python 3.8 on Windows
* 1861: Fix empty namespace package installation from wheel.
* 1877: Setuptools now exposes a new entry point hook "setuptools.finalize_distribution_options", enabling plugins like `setuptools_scm <https://pypi.org/project/setuptools_scm>`_ to configure options on the distribution at finalization time.

41.6.0

-------



Changes
^^^^^^^
* 479: Replace usage of deprecated ``imp`` module with local re-implementation in ``setuptools._imp``.

41.5.1

-------



Changes
^^^^^^^
* 1891: Fix code for detecting Visual Studio's version on Windows under Python 2.

41.5.0

-------



Changes
^^^^^^^
* 1811: Improve Visual C++ 14.X support, mainly for Visual Studio 2017 and 2019.
* 1814: Fix ``pkg_resources.Requirement`` hash/equality implementation: take PEP 508 direct URL into account.
* 1824: Fix tests when running under ``python3.10``.
* 1878: Formally deprecated the ``test`` command, with the recommendation that users migrate to ``tox``.

Documentation changes
^^^^^^^^^^^^^^^^^^^^^
* 1860: Update documentation to mention the egg format is not supported by pip and dependency links support was dropped starting with pip 19.0.
* 1862: Drop ez_setup documentation: deprecated for some time (last updated in 2016), and still relying on easy_install (deprecated too).
* 1868: Drop most documentation references to (deprecated) EasyInstall.
* 1884: Added a trove classifier to document support for Python 3.8.

Misc
^^^^
* 1886: Added Python 3.8 release to the Travis test matrix.

41.4.0

-------



Changes
^^^^^^^
* 1847: In declarative config, now traps errors when invalid ``python_requires`` values are supplied.

41.3.0

-------



Changes
^^^^^^^
* 1690: When storing extras, rely on OrderedSet to retain order of extras as indicated by the packager, which will also be deterministic on Python 2.7 (with PYTHONHASHSEED unset) and Python 3.6+.

Misc
^^^^
* 1858: Fixed failing integration test triggered by 'long_description_content_type' in packaging.
Links

Update docutils from 0.15.2 to 0.16.

Changelog

0.16

=========================

.. Note::

Docutils 0.15.x is the last version supporting Python 2.6, 3.3 and 3.4.

Docutils 0.16.x supports Python 2.7 and Python >= 3.5 natively,
without the use of the ``2to3`` tool.

* reStructuredText:

- Keep `backslash escapes`__ in the document tree. This allows, e.g.,
 escaping of author-separators in `bibliographic fields`__.

__ http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.htmlescaping-mechanism
__ docs/ref/rst/restructuredtext.htmlbibliographic-fields

* LaTeX writer:

- Informal titles of type "rubric" default to bold-italic and left aligned.
- Deprecate ``\docutilsrole`` prefix for styling commands:
 use ``\DUrole`` instead.
- Fix topic subtitle.
- Add "latex writers" to the `config_section_dependencies`.
- Ignore classes for `rubric` elements
 (class wrapper interferes with LaTeX formatting).

* tools/buildhtml.py

- New option "--html-writer" allows to select "html__" (default),
 "html4" or "html5".

__ html: docs/user/html.htmlhtml

* docutils/io.py

- Remove the `handle_io_errors` option from io.FileInput/Output.

* docutils/nodes.py

- If `auto_id_prefix`_ ends with "%", this is replaced with the tag name.

.. _auto_id_prefix: docs/user/config.htmlauto-id-prefix

* Various bugfixes and improvements (see HISTORY_).
Links

Update Pygments from 2.4.2 to 2.7.3.

Changelog

2.7.3

-------------
(released December 6, 2020)

- Updated lexers:

* Ada (PR1581)
* HTML (PR1615, 1614)
* Java (PR1594, 1586)
* JavaScript (PR1605, PR1589, 1588)
* JSON (PR1569 -- this is a complete rewrite)
* Lean (PR1601)
* LLVM (PR1612)
* Mason (PR1592)
* MySQL (PR1555, 1551)
* Rust (PR1608)
* Turtle (PR1590, 1553)

- Deprecated JsonBareObjectLexer, which is now identical to JsonLexer (1600)
- The ``ImgFormatter`` now calculates the exact character width, which fixes some issues with overlapping text (1213, PR1611)
- Documentation fixes (PR1609, 1599, 1598)
- Fixed duplicated Juttle language alias (1604, PR1606)
- Added support for Kotlin scripts (PR1587)
- Removed CSS rule which forced margin to 0

2.7.2

-------------
(released October 24, 2020)

- Updated lexers:

* Latex (PR1517, 1516)
* LLVM (PR1565)
* SPARQL (PR1559)

- Fixed Python console/traceback lexer problems with custom exceptions without messages (1548)
- Allow loading ttc fonts on Mac/image formatter (1223)
- Improved ``analyze_text`` across a variety of lexers (PR1549)
- Removed CSS rule which forced the vertical padding to 0 for line numbers (PR1583, 1579)
- Fixed ``TNTLexer`` crashing on unexpected EOL (1568, PR1570)
- ``regexlint`` can be now run locally as part of ``tox`` tests (PR1557)
- Fixed typos (PR1550, 1562)
- Added Python 3.9 as a supported version (PR1554)

2.7.1

-------------
(released September 16, 2020)

- Fixed a regression in the JSON lexer (1544)

2.7.0

-------------
(released September 12, 2020)

- Added lexers:

* Arrow (PR1481, PR1499)
* BARE (PR1488)
* Devicetree (PR1434)
* F* (PR1409)
* GDScript (PR1457)
* Pointless (PR1494)
* PromQL (PR1506)
* PsySH (PR1438)
* Singularity (PR1285)
* TiddlyWiki5 (PR1390)
* TNT (PR1414)
* YANG (PR1408, PR1428)

- Updated lexers:

* APL (PR1503)
* C++ (PR1350, which also fixes: 1222, 996, 906, 828, 1162, 1166,
 1396)
* Chapel (PR1423)
* CMake (1491)
* CSound (1509)
* Cython (PR1507)
* Dart (PR1449)
* Fennel (PR1535)
* Fortran (PR1442)
* GAS (PR1530)
* HTTP (PR1432, 1520, PR1521)
* Inform 6 (PR1461)
* Javascript (PR1533)
* JSON (1065, PR1528)
* Lean (PR1415)
* Matlab (PR1399)
* Markdown (1492, PR1495)
* MySQL (975, 1063, 1453, PR1527)
* NASM (PR1465)
* Nim (PR1426)
* PostgreSQL (PR1513)
* PowerShell (PR1398, PR1497)
* Protobuf (PR1505)
* Robot (PR1480)
* SQL (PR1402)
* SystemVerilog (PR1436, PR1452, PR1454, PR1460, PR1462, PR1463, PR1464, PR1471, 1496, PR1504)
* TeraTerm (PR1337)
* XML (1502)

- Added a new filter for math symbols (PR1406)
- The Kconfig lexer will match Kconfig derivative names now (PR1458)
- Improved HTML formatter output (PR1500)
- ``.markdown`` is now recognized as an extension for Markdown files (PR1476)
- Fixed line number colors for Solarized (PR1477, 1356)
- Improvements to exception handling (PR1478)
- Improvements to tests (PR1532, PR1533, PR1539)
- Various code cleanups (PR1536, PR1537, PR1538)

2.6.1

-------------
(released March 8, 2020)

- This release fixes a packaging issue. No functional changes.

2.6

-----------
(released March 8, 2020)

- Running Pygments on Python 2.x is no longer supported.
(The Python 2 lexer still exists.)

- Added lexers:

* Linux kernel logs (PR1310)
* LLVM MIR (PR1361)
* MiniScript (PR1397)
* Mosel (PR1287, PR1326)
* Parsing Expression Grammar (PR1336)
* ReasonML (PR1386)
* Ride (PR1319, PR1321)
* Sieve (PR1257)
* USD (PR1290)
* WebIDL (PR1309)

- Updated lexers:

* Apache2 (PR1378)
* Chapel (PR1357)
* CSound (PR1383)
* D (PR1375, PR1362)
* Idris (PR1360)
* Perl6/Raku lexer (PR1344)
* Python3 (PR1382, PR1385)
* Rust: Updated lexer to cover more builtins (mostly macros) and miscellaneous
 new syntax (PR1320)
* SQL: Add temporal support keywords (PR1402)

- The 256-color/true-color terminal formatters now support the italic attribute
in styles (PR1288)
- Support HTTP 2/3 header (PR1308)
- Support missing reason in HTTP header (PR1322)
- Boogie/Silver: support line continuations and triggers, move contract keywords
to separate category (PR1299)
- GAS: support C-style comments (PR1291)
- Fix names in S lexer (PR1330, PR1333)
- Fix numeric literals in Ada (PR1334)
- Recognize ``.mjs`` files as Javascript (PR1392)
- Recognize ``.eex`` files as Elixir (PR1387)
- Fix ``re.MULTILINE`` usage (PR1388)
- Recognize ``pipenv`` and ``poetry`` dependency & lock files (PR1376)
- Improve font search on Windows (1247)
- Remove unused script block (1401)

2.5.2

-------------
(released November 29, 2019)

- Fix incompatibility with some setuptools versions (PR1316)

- Fix lexing of ReST field lists (PR1279)
- Fix lexing of Matlab keywords as field names (PR1282)
- Recognize double-quoted strings in Matlab (PR1278)
- Avoid slow backtracking in Vim lexer (PR1312)
- Fix Scala highlighting of types (PR1315)
- Highlight field lists more consistently in ReST (PR1279)
- Fix highlighting Matlab keywords in field names (PR1282)
- Recognize Matlab double quoted strings (PR1278)
- Add some Terraform keywords
- Update Modelica lexer to 3.4
- Update Crystal examples

2.5.1

-------------
(released November 26, 2019)

- This release fixes a packaging issue. No functional changes.

2.5.0

-------------
(released November 26, 2019)

- Added lexers:

* Email (PR1246)
* Erlang, Elixir shells (PR823, 1521)
* Notmuch (PR1264)
* `Scdoc <https://git.sr.ht/~sircmpwn/scdoc>`_ (PR1268)
* `Solidity <https://solidity.readthedocs.io/>`_ (1214)
* `Zeek <https://www.zeek.org>`_ (new name for Bro) (PR1269)
* `Zig <https://ziglang.org/>`_ (PR820)

- Updated lexers:

* Apache2 Configuration (PR1251)
* Bash sessions (1253)
* CSound (PR1250)
* Dart
* Dockerfile
* Emacs Lisp
* Handlebars (PR773)
* Java (1101, 987)
* Logtalk (PR1261)
* Matlab (PR1271)
* Praat (PR1277)
* Python3 (PR1255, PR1400)
* Ruby
* YAML (1528)
* Velocity

- Added styles:

* Inkpot (PR1276)

- The ``PythonLexer`` class is now an alias for the former ``Python3Lexer``.
The old ``PythonLexer`` is available as ``Python2Lexer``.  Same change has
been done for the ``PythonTracebackLexer``.  The ``python3`` option for
the ``PythonConsoleLexer`` is now true by default.

- Bump ``NasmLexer`` priority over ``TasmLexer`` for ``.asm`` files
(fixes 1326)
- Default font in the ``ImageFormatter`` has been updated (928, PR1245)
- Test suite switched to py.test, removed nose dependency (1490)
- Reduce ``TeraTerm`` lexer score -- it used to match nearly all languages
(1256)
- Treat ``Skylark``/``Starlark`` files as Python files (PR1259)
- Image formatter: actually respect ``line_number_separator`` option

- Add LICENSE file to wheel builds
- Agda: fix lambda highlighting
- Dart: support ` annotations
- Dockerfile: accept ``FROM ... AS`` syntax
- Emacs Lisp: add more string functions
- GAS: accept registers in directive arguments
- Java: make structural punctuation (braces, parens, colon, comma) ``Punctuation``, not ``Operator`` (987)
- Java: support ``var`` contextual keyword (1101)
- Matlab: Fix recognition of ``function`` keyword (PR1271)
- Python: recognize ``.jy`` filenames (976)
- Python: recognize ``f`` string prefix (1156)
- Ruby: support squiggly heredocs
- Shell sessions: recognize Virtualenv prompt (PR1266)
- Velocity: support silent reference syntax
Links

Update codecov from 2.0.15 to 2.1.11.

Changelog

2.1.11

Fixes
- 305 Added option to disable printing of gcov-out
- 308 Handle exceptions that don't have a returncode

Dependencies and Misc
- 301 Update to Python 3.9

2.1.10

Fixes
- [148](https://github.com/codecov/codecov-python/pull/148) Output elapsed time with S3 upload
- [153](https://github.com/codecov/codecov-python/pull/153) Improve error reporting in the "try_run" function and correctly include original command output in the error message
- [295](https://github.com/codecov/codecov-python/pull/295) Added sleep between upload retries.
- [297](https://github.com/codecov/codecov-python/pull/297) Ignore emacs lisp files
- [298](https://github.com/codecov/codecov-python/pull/298) Fix error try_to_run using | without shell=True (fix 284)

Dependencies and Misc
- [290](https://github.com/codecov/codecov-python/pull/290) Bump coverage from 4.5.4 to 5.2.1
- [291](https://github.com/codecov/codecov-python/pull/291) Update python versions
- [292](https://github.com/codecov/codecov-python/pull/292) Add license scan report and status
- [294](https://github.com/codecov/codecov-python/pull/294) Update README with accurate links
- [296](https://github.com/codecov/codecov-python/pull/296) Bump coverage from 5.2.1 to 5.3

2.1.9

- [289](https://github.com/codecov/codecov-python/pull/289)Remove token restriction as it is changed server-side

2.1.8

- [285](https://github.com/codecov/codecov-python/pull/285)Add support for CODECOV_FLAGS
- [276](https://github.com/codecov/codecov-python/pull/276)Add ability to specify number of upload retries

2.1.7

- [279](https://github.com/codecov/codecov-python/pull/279) Fix pinned coverage version

2.1.6

- [275](https://github.com/codecov/codecov-python/pull/275) Fix GitHub Actions implementation

2.1.5

- [273](https://github.com/codecov/codecov-python/pull/273) Implement retries on Codecov API calls
- [265](https://github.com/codecov/codecov-python/pull/265) Add GitHub Actions CI detection
- [267](https://github.com/codecov/codecov-python/pull/267) Add CODECOV_NAME as default for name

2.1.4

- [260](https://github.com/codecov/codecov-python/pull/260) Enforce black formatting
- [169](https://github.com/codecov/codecov-python/pull/169) Fix command line quoting on Windows
- [216](https://github.com/codecov/codecov-python/pull/216) Fix GitLab CI project directory detection on Windows
- [264](https://github.com/codecov/codecov-python/pull/264) Fix GitLab CI post version 9
- [262](https://github.com/codecov/codecov-python/pull/262) Check text for NoneType on writes
- [266](https://github.com/codecov/codecov-python/pull/266) Include the cacert in the PUT call when uploading to S3
- [263](https://github.com/codecov/codecov-python/pull/263) Fixed gcov not being found in certain instances

2.1.3

- Fix find command not working on Windows
- Add support for gzipping reports
- Dynamic syncing of version

2.1.1

- Fix command when neither hg or git are not available

2.1.0

- Remove x-amz-acl header
- Reformat with Black

2.0.22

- Cleaning TOC generation

2.0.21

- fixed string issues

2.0.20

- fixed broken subprocess handling

2.0.19

- fixed broken subprocess handling

2.0.18

- fixed broken subprocess handling

2.0.17

- fixed reported command injection vulnerability.

2.0.16

- fixed reported command injection vulnerability.
Links

Update green from 3.0.0 to 3.2.5.

Changelog

3.2.5

23 Nov 2020

- Fix failing/erroring SubTests not properly reporting output to stdout/stderr. Resolves 238.

3.2.4

1 Nov 2020

- Fix `-j/--junit-report` so that it writes to the properly-named file when specified from a config file. Contributed by jwaschkau in 236.
- Fix Windows CI by dropping a broken Python 2 test.

3.2.3

11 Oct 2020

- Properly clean up temporary files in some versions/platforms. Contributed by Icerman in 232.
Resolves 228.
- Fix an unwanted "1A" appearing at the beginning of test result lines in CI such as GitHub Actions
and AppVeyor.

3.2.2

22 Sep 2020

- Fix help string for the `-O/--clear-omit` option. Resolves 231.
- Tweak a bit of green's self-coverage to adjust for making releases in Python 3.8

3.2.1

9 Aug 2020

- Fix passing tests not displaying captured stderr output unless stdout output was also present.
Resolves 226.

3.2.0

6 June 2020

- Fix crashes and hangs that could occur when using >1 subprocess due to a regression introduced in 3.1.1.
- Add 'time' attributes to the `<testsuites>`, `<testsuite>`, and `<testcase>` fields in the Junit
output for the `-j/--junit-report` output.  Contributed by bkmd11 in 225. Resolves 208.

3.1.4

7 May 2020

- Fix class/module teardowns being ignored. They are now reported as errors as they should be. Resolves 223.
- Fix dates in this changelog--I was still using last year! 😆

3.1.3

5 May 2020

- Fix crash that could occur when whitespace is in the path on Windows.
Contributed by bkmd11 in 222.

3.1.2

4 May 2020

- Fix a crash that could occur during cleanup on unusual filesystems on
Python 2. Note that Python 2 is still not supported...but might as well fix
stuff if it is easy to fix. :-) Resolves 221.

3.1.1

22 April 2020

- Fixed a hang that sometimes occurs in Python 3.8.0-3.8.2 due to a bug in upstream Python
- Upstream bug report: https://bugs.python.org/issue39360
- Upstream fix in master: https://github.com/python/cpython/pull/19009
- Upstream fix in 3.8 branch (Maybe gets included in 3.8.3?): https://github.com/python/cpython/pull/19023
- Fixed behavior of raising SkipTest in a setUpClass class method on Python >= 3.8

3.1.0

3 Jan 2020

- You can now financially support Green by sponsoring CleanCut at
https://github.com/sponsors/CleanCut

- Added support for DocTests.  I got interested in why charles-l's attempt to
crash instead of hang when doctests were encountered didn't work, and ended
up just adding support as a feature.  To parse/run doctests for a particular
module, in a _test_ module add `doctest_modules = [ ... ]` where each item
is (preferably) an imported module or a dotted string representing a module
to be imported that contains tests in docstrings.  Resolves 88, 214.

- Fixed a crash and a test failure that could occur with Coverage 5.x

- Updated TravisCI builds with Python 3.8 on Linux and Xcode 11.3 on macOS.
Links

Update coverage from 4.5.4 to 5.3.1.

Changelog

5.3.1

----------------------------

- When using ``--source`` on a large source tree, v5.x was slower than previous
versions.  This performance regression is now fixed, closing `issue 1037`_.

- Mysterious SQLite errors can happen on PyPy, as reported in `issue 1010`_. An
immediate retry seems to fix the problem, although it is an unsatisfying
solution.

- The HTML report now saves the sort order in a more widely supported way,
fixing `issue 986`_.  Thanks, Sebastián Ramírez (`pull request 1066`_).

- The HTML report pages now have a :ref:`Sleepy Snake <sleepy>` favicon.

- Wheels are now provided for manylinux2010, and for PyPy3 (pp36 and pp37).

- Continuous integration has moved from Travis and AppVeyor to GitHub Actions.

.. _issue 986: https://github.com/nedbat/coveragepy/issues/986
.. _issue 1037: https://github.com/nedbat/coveragepy/issues/1037
.. _issue 1010: https://github.com/nedbat/coveragepy/issues/1010
.. _pull request 1066: https://github.com/nedbat/coveragepy/pull/1066

.. _changes_53:

5.3

--------------------------

- The ``source`` setting has always been interpreted as either a file path or a
module, depending on which existed.  If both interpretations were valid, it
was assumed to be a file path.  The new ``source_pkgs`` setting can be used
to name a package to disambiguate this case.  Thanks, Thomas Grainger. Fixes
`issue 268`_.

- If a plugin was disabled due to an exception, we used to still try to record
its information, causing an exception, as reported in `issue 1011`_.  This is
now fixed.

.. _issue 268: https://github.com/nedbat/coveragepy/issues/268
.. _issue 1011: https://github.com/nedbat/coveragepy/issues/1011


.. _changes_521:

5.2.1

----------------------------

- The dark mode HTML report still used light colors for the context listing,
making them unreadable (`issue 1009`_).  This is now fixed.

- The time stamp on the HTML report now includes the time zone. Thanks, Xie
Yanbo (`pull request 960`_).

.. _pull request 960: https://github.com/nedbat/coveragepy/pull/960
.. _issue 1009: https://github.com/nedbat/coveragepy/issues/1009


.. _changes_52:

5.2

--------------------------

- The HTML report has been redesigned by Vince Salvino.  There is now a dark
mode, the code text is larger, and system sans serif fonts are used, in
addition to other small changes (`issue 858`_ and `pull request 931`_).

- The ``coverage report`` and ``coverage html`` commands now accept a
``--precision`` option to control the number of decimal points displayed.
Thanks, Teake Nutma (`pull request 982`_).

- The ``coverage report`` and ``coverage html`` commands now accept a
``--no-skip-covered`` option to negate ``--skip-covered``.  Thanks, Anthony
Sottile (`issue 779`_ and `pull request 932`_).

- The ``--skip-empty`` option is now available for the XML report, closing
`issue 976`_.

- The ``coverage report`` command now accepts a ``--sort`` option to specify
how to sort the results.  Thanks, Jerin Peter George (`pull request 1005`_).

- If coverage fails due to the coverage total not reaching the ``--fail-under``
value, it will now print a message making the condition clear.  Thanks,
Naveen Yadav (`pull request 977`_).

- TOML configuration files with non-ASCII characters would cause errors on
Windows (`issue 990`_).  This is now fixed.

- The output of ``--debug=trace`` now includes information about how the
``--source`` option is being interpreted, and the module names being
considered.

.. _pull request 931: https://github.com/nedbat/coveragepy/pull/931
.. _pull request 932: https://github.com/nedbat/coveragepy/pull/932
.. _pull request 977: https://github.com/nedbat/coveragepy/pull/977
.. _pull request 982: https://github.com/nedbat/coveragepy/pull/982
.. _pull request 1005: https://github.com/nedbat/coveragepy/pull/1005
.. _issue 779: https://github.com/nedbat/coveragepy/issues/779
.. _issue 858: https://github.com/nedbat/coveragepy/issues/858
.. _issue 976: https://github.com/nedbat/coveragepy/issues/976
.. _issue 990: https://github.com/nedbat/coveragepy/issues/990


.. _changes_51:

5.1

--------------------------

- The JSON report now includes counts of covered and missing branches. Thanks,
Salvatore Zagaria.

- On Python 3.8, try-finally-return reported wrong branch coverage with
decorated async functions (`issue 964`_).  This is now fixed. Thanks, Kjell
Braden.

- The :meth:`~coverage.Coverage.get_option` and
:meth:`~coverage.Coverage.set_option` methods can now manipulate the
``[paths]`` configuration setting.  Thanks to Bernát Gábor for the fix for
`issue 967`_.

.. _issue 964: https://github.com/nedbat/coveragepy/issues/964
.. _issue 967: https://github.com/nedbat/coveragepy/issues/967


.. _changes_504:

5.0.4

----------------------------

- If using the ``[run] relative_files`` setting, the XML report will use
relative files in the ``<source>`` elements indicating the location of source
code.  Closes `issue 948`_.

- The textual summary report could report missing lines with negative line
numbers on PyPy3 7.1 (`issue 943`_).  This is now fixed.

- Windows wheels for Python 3.8 were incorrectly built, but are now fixed.
(`issue 949`_)

- Updated Python 3.9 support to 3.9a4.

- HTML reports couldn't be sorted if localStorage wasn't available. This is now
fixed: sorting works even though the sorting setting isn't retained. (`issue
944`_ and `pull request 945`_). Thanks, Abdeali Kothari.

.. _issue 943: https://github.com/nedbat/coveragepy/issues/943
.. _issue 944: https://github.com/nedbat/coveragepy/issues/944
.. _pull request 945: https://github.com/nedbat/coveragepy/pull/945
.. _issue 948: https://github.com/nedbat/coveragepy/issues/948
.. _issue 949: https://github.com/nedbat/coveragepy/issues/949


.. _changes_503:

5.0.3

----------------------------

- A performance improvement in 5.0.2 didn't work for test suites that changed
directory before combining data, causing "Couldn't use data file: no such
table: meta" errors (`issue 916`_).  This is now fixed.

- Coverage could fail to run your program with some form of "ModuleNotFound" or
"ImportError" trying to import from the current directory. This would happen
if coverage had been packaged into a zip file (for example, on Windows), or
was found indirectly (for example, by pyenv-virtualenv).  A number of
different scenarios were described in `issue 862`_ which is now fixed.  Huge
thanks to Agbonze O. Jeremiah for reporting it, and Alexander Waters and
George-Cristian Bîrzan for protracted debugging sessions.

- Added the "premain" debug option.

- Added SQLite compile-time options to the "debug sys" output.

.. _issue 862: https://github.com/nedbat/coveragepy/issues/862
.. _issue 916: https://github.com/nedbat/coveragepy/issues/916


.. _changes_502:

5.0.2

----------------------------

- Programs that used multiprocessing and changed directories would fail under
coverage.  This is now fixed (`issue 890`_).  A side effect is that debug
information about the config files read now shows absolute paths to the
files.

- When running programs as modules (``coverage run -m``) with ``--source``,
some measured modules were imported before coverage starts.  This resulted in
unwanted warnings ("Already imported a file that will be measured") and a
reduction in coverage totals (`issue 909`_).  This is now fixed.

- If no data was collected, an exception about "No data to report" could happen
instead of a 0% report being created (`issue 884`_).  This is now fixed.

- The handling of source files with non-encodable file names has changed.
Previously, if a file name could not be encoded as UTF-8, an error occurred,
as described in `issue 891`_.  Now, those files will not be measured, since
their data would not be recordable.

- A new warning ("dynamic-conflict") is issued if two mechanisms are trying to
change the dynamic context.  Closes `issue 901`_.

- ``coverage run --debug=sys`` would fail with an AttributeError. This is now
fixed (`issue 907`_).

.. _issue 884: https://github.com/nedbat/coveragepy/issues/884
.. _issue 890: https://github.com/nedbat/coveragepy/issues/890
.. _issue 891: https://github.com/nedbat/coveragepy/issues/891
.. _issue 901: https://github.com/nedbat/coveragepy/issues/901
.. _issue 907: https://github.com/nedbat/coveragepy/issues/907
.. _issue 909: https://github.com/nedbat/coveragepy/issues/909


.. _changes_501:

5.0.1

----------------------------

- If a 4.x data file is the cause of a "file is not a database" error, then use
a more specific error message, "Looks like a coverage 4.x data file, are you
mixing versions of coverage?"  Helps diagnose the problems described in
`issue 886`_.

- Measurement contexts and relative file names didn't work together, as
reported in `issue 899`_ and `issue 900`_.  This is now fixed, thanks to
David Szotten.

- When using ``coverage run --concurrency=multiprocessing``, all data files
should be named with parallel-ready suffixes.  5.0 mistakenly named the main
process' file with no suffix when using ``--append``.  This is now fixed,
closing `issue 880`_.

- Fixed a problem on Windows when the current directory is changed to a
different drive (`issue 895`_).  Thanks, Olivier Grisel.

- Updated Python 3.9 support to 3.9a2.

.. _issue 880: https://github.com/nedbat/coveragepy/issues/880
.. _issue 886: https://github.com/nedbat/coveragepy/issues/886
.. _issue 895: https://github.com/nedbat/coveragepy/issues/895
.. _issue 899: https://github.com/nedbat/coveragepy/issues/899
.. _issue 900: https://github.com/nedbat/coveragepy/issues/900


.. _changes_50:

5.0

--------------------------

Nothing new beyond 5.0b2.


.. _changes_50b2:

5.0b2

----------------------------

- An experimental ``[run] relative_files`` setting tells coverage to store
relative file names in the data file. This makes it easier to run tests in
one (or many) environments, and then report in another.  It has not had much
real-world testing, so it may change in incompatible ways in the future.

- When constructing a :class:`coverage.Coverage` object, `data_file` can be
specified as None to prevent writing any data file at all.  In previous
versions, an explicit `data_file=None` argument would use the default of
".coverage". Fixes `issue 871`_.

- Python files run with ``-m`` now have ``__spec__`` defined properly.  This
fixes `issue 745`_ (about not being able to run unittest tests that spawn
subprocesses), and `issue 838`_, which described the problem directly.

- The ``[paths]`` configuration section is now ordered. If you specify more
than one list of patterns, the first one that matches will be used.  Fixes
`issue 649`_.

- The :func:`.coverage.numbits.register_sqlite_functions` function now also
registers `numbits_to_nums` for use in SQLite queries.  Thanks, Simon
Willison.

- Python 3.9a1 is supported.

- Coverage.py has a mascot: :ref:`Sleepy Snake <sleepy>`.

.. _issue 649: https://github.com/nedbat/coveragepy/issues/649
.. _issue 745: https://github.com/nedbat/coveragepy/issues/745
.. _issue 838: https://github.com/nedbat/coveragepy/issues/838
.. _issue 871: https://github.com/nedbat/coveragepy/issues/871


.. _changes_50b1:

5.0b1

----------------------------

- The HTML and textual reports now have a ``--skip-empty`` option that skips
files with no statements, notably ``__init__.py`` files.  Thanks, Reya B.

- Configuration can now be read from `TOML`_ files.  This requires installing
coverage.py with the ``[toml]`` extra.  The standard "pyproject.toml" file
will be read automatically if no other configuration file is found, with
settings in the ``[tool.coverage.]`` namespa

@codecov

codecov Bot commented Jan 1, 2021

Copy link
Copy Markdown

Codecov Report

Merging #26 (04df536) into master (c3082f6) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master      #26   +/-   ##
=======================================
  Coverage   66.96%   66.96%           
=======================================
  Files           3        3           
  Lines         112      112           
=======================================
  Hits           75       75           
  Misses         37       37           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c3082f6...04df536. Read the comment docs.

@pyup-bot

pyup-bot commented Feb 1, 2021

Copy link
Copy Markdown
Collaborator Author

Closing this in favor of #27

@pyup-bot pyup-bot closed this Feb 1, 2021
@merlink01 merlink01 deleted the pyup-scheduled-update-2021-01-01 branch February 1, 2021 17:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant