bosondata / badwolf

Docker based continuous integration, continuous deployment and code lint review system for BitBucket
https://badwolf.readthedocs.io/en/latest/
MIT License
88 stars 12 forks source link

Initial Update #11

Closed pyup-bot closed 7 years ago

pyup-bot commented 7 years ago

This is my first visit to this fine repo so I have bundled all updates in a single pull request to make things easier for you to merge.

Close this pull request and delete the branch if you want me to start with single pull requests right away

Here's the executive summary:

Updates

Here's a list of all the updates bundled in this pull request. I've added some links to make it easier for you to find all the information you need.

mock 2.0.0 » 2.0.0 PyPi | Repo
requests 2.11.1 » 2.11.1 PyPi | Changelog | Homepage
coverage 4.2 » 4.2 PyPi | Changelog | Docs
certifi 2016.9.26 » 2016.9.26 PyPi | Homepage
Sphinx 1.4.8 » 1.4.8 PyPi | Homepage
pytest 3.0.3 » 3.0.3 PyPi | Changelog | Homepage
pytest-cov 2.4.0 » 2.4.0 PyPi | Changelog | Repo
pytest-capturelog 0.7 » 0.7 PyPi | Repo

Changelogs

requests -> 2.11.1

2.11.1

+++++++++++++++++++

Bugfixes

  • Fixed a bug when using iter_content with decode_unicode=True for streamed bodies would raise AttributeError. This bug was introduced in 2.11.
  • Strip Content-Type and Transfer-Encoding headers from the header block when following a redirect that transforms the verb from POST/PUT to GET.

    2.11.0

+++++++++++++++++++

Improvements

  • Added support for the ALL_PROXY environment variable.
  • Reject header values that contain leading whitespace or newline characters to reduce risk of header smuggling.

Bugfixes

  • Fixed occasional TypeError when attempting to decode a JSON response that occurred in an error case. Now correctly returns a ValueError.
  • Requests would incorrectly ignore a non-CIDR IP address in the NO_PROXY environment variables: Requests now treats it as a specific IP.
  • Fixed a bug when sending JSON data that could cause us to encounter obscure OpenSSL errors in certain network conditions (yes, really).
  • Added type checks to ensure that iter_content only accepts integers and None for chunk sizes.
  • Fixed issue where responses whose body had not been fully consumed would have the underlying connection closed but not returned to the connection pool, which could cause Requests to hang in situations where the HTTPAdapter had been configured to use a blocking connection pool.

Miscellaneous

  • Updated bundled urllib3 to 1.16.
  • Some previous releases accidentally accepted non-strings as acceptable header values. This release does not.

    2.10.0

+++++++++++++++++++

New Features

  • SOCKS Proxy Support! (requires PySocks; $ pip install requests[socks])

Miscellaneous

  • Updated bundled urllib3 to 1.15.1.

    2.9.2

++++++++++++++++++

Improvements

  • Change built-in CaseInsensitiveDict (used for headers) to use OrderedDict as its underlying datastore.

Bugfixes

  • Don't use redirect_cache if allow_redirects=False
  • When passed objects that throw exceptions from tell(), send them via chunked transfer encoding instead of failing.
  • Raise a ProxyError for proxy related connection issues.

    2.9.1

++++++++++++++++++

Bugfixes

  • Resolve regression introduced in 2.9.0 that made it impossible to send binary strings as bodies in Python 3.
  • Fixed errors when calculating cookie expiration dates in certain locales.

Miscellaneous

  • Updated bundled urllib3 to 1.13.1.

    2.9.0

++++++++++++++++++

Minor Improvements (Backwards compatible)

  • The verify keyword argument now supports being passed a path to a directory of CA certificates, not just a single-file bundle.
  • Warnings are now emitted when sending files opened in text mode.
  • Added the 511 Network Authentication Required status code to the status code registry.

Bugfixes

  • For file-like objects that are not seeked to the very beginning, we now send the content length for the number of bytes we will actually read, rather than the total size of the file, allowing partial file uploads.
  • When uploading file-like objects, if they are empty or have no obvious content length we set Transfer-Encoding: chunked rather than Content-Length: 0.
  • We correctly receive the response in buffered mode when uploading chunked bodies.
  • We now handle being passed a query string as a bytestring on Python 3, by decoding it as UTF-8.
  • Sessions are now closed in all cases (exceptional and not) when using the functional API rather than leaking and waiting for the garbage collector to clean them up.
  • Correctly handle digest auth headers with a malformed qop directive that contains no token, by treating it the same as if no qop directive was provided at all.
  • Minor performance improvements when removing specific cookies by name.

Miscellaneous

  • Updated urllib3 to 1.13.

    2.8.1

++++++++++++++++++

Bugfixes

  • Update certificate bundle to match certifi 2015.9.6.2's weak certificate bundle.
  • Fix a bug in 2.8.0 where requests would raise ConnectTimeout instead of ConnectionError
  • When using the PreparedRequest flow, requests will now correctly respect the json parameter. Broken in 2.8.0.
  • When using the PreparedRequest flow, requests will now correctly handle a Unicode-string method name on Python 2. Broken in 2.8.0.

    2.8.0

++++++++++++++++++

Minor Improvements (Backwards Compatible)

  • Requests now supports per-host proxies. This allows the proxies dictionary to have entries of the form {'<scheme>://<hostname>': '<proxy>'}. Host-specific proxies will be used in preference to the previously-supported scheme-specific ones, but the previous syntax will continue to work.
  • Response.raise_for_status now prints the URL that failed as part of the exception message.
  • requests.utils.get_netrc_auth now takes an raise_errors kwarg, defaulting to False. When True, errors parsing .netrc files cause exceptions to be thrown.
  • Change to bundled projects import logic to make it easier to unbundle requests downstream.
  • Changed the default User-Agent string to avoid leaking data on Linux: now contains only the requests version.

Bugfixes

  • The json parameter to post() and friends will now only be used if neither data nor files are present, consistent with the documentation.
  • We now ignore empty fields in the NO_PROXY environment variable.
  • Fixed problem where httplib.BadStatusLine would get raised if combining stream=True with contextlib.closing.
  • Prevented bugs where we would attempt to return the same connection back to the connection pool twice when sending a Chunked body.
  • Miscellaneous minor internal changes.
  • Digest Auth support is now thread safe.

Updates

  • Updated urllib3 to 1.12.

    2.7.0

++++++++++++++++++

This is the first release that follows our new release process. For more, see our documentation <http://docs.python-requests.org/en/latest/community/release-process/>_.

Bugfixes

  • Updated urllib3 to 1.10.4, resolving several bugs involving chunked transfer encoding and response framing.

    2.6.2

++++++++++++++++++

Bugfixes

  • Fix regression where compressed data that was sent as chunked data was not properly decompressed. (2561)

    2.6.1

++++++++++++++++++

Bugfixes

  • Remove VendorAlias import machinery introduced in v2.5.2.
  • Simplify the PreparedRequest.prepare API: We no longer require the user to pass an empty list to the hooks keyword argument. (c.f. 2552)
  • Resolve redirects now receives and forwards all of the original arguments to the adapter. (2503)
  • Handle UnicodeDecodeErrors when trying to deal with a unicode URL that cannot be encoded in ASCII. (2540)
  • Populate the parsed path of the URI field when performing Digest Authentication. (2426)
  • Copy a PreparedRequest's CookieJar more reliably when it is not an instance of RequestsCookieJar. (2527)

    2.6.0

++++++++++++++++++

Bugfixes

  • CVE-2015-2296: Fix handling of cookies on redirect. Previously a cookie without a host value set would use the hostname for the redirected URL exposing requests users to session fixation attacks and potentially cookie stealing. This was disclosed privately by Matthew Daley of BugFuzz <https://bugfuzz.com>_. This affects all versions of requests from v2.1.0 to v2.5.3 (inclusive on both ends).
  • Fix error when requests is an install_requires dependency and python setup.py test is run. (2462)
  • Fix error when urllib3 is unbundled and requests continues to use the vendored import location.
  • Include fixes to urllib3's header handling.
  • Requests' handling of unvendored dependencies is now more restrictive.

Features and Improvements

  • Support bytearrays when passed as parameters in the files argument. (2468)
  • Avoid data duplication when creating a request with str, bytes, or bytearray input to the files argument.

    2.5.3

++++++++++++++++++

Bugfixes

++++++++++++++++++

Features and Improvements

  • Add sha256 fingerprint support. (shazow/urllib3540_)
  • Improve the performance of headers. (shazow/urllib3544_)

Bugfixes

  • Copy pip's import machinery. When downstream redistributors remove requests.packages.urllib3 the import machinery will continue to let those same symbols work. Example usage in requests' documentation and 3rd-party libraries relying on the vendored copies of urllib3 will work without having to fallback to the system urllib3.
  • Attempt to quote parts of the URL on redirect if unquoting and then quoting fails. (2356)
  • Fix filename type check for multipart form-data uploads. (2411)
  • Properly handle the case where a server issuing digest authentication challenges provides both auth and auth-int qop-values. (2408)
  • Fix a socket leak. (shazow/urllib3549_)
  • Fix multiple Set-Cookie headers properly. (shazow/urllib3534_)
  • Disable the built-in hostname verification. (shazow/urllib3526_)
  • Fix the behaviour of decoding an exhausted stream. (shazow/urllib3535_)

Security

  • Pulled in an updated cacert.pem.
  • Drop RC4 from the default cipher list. (shazow/urllib3551_)

.. _shazow/urllib3551: https://github.com/shazow/urllib3/pull/551 .. _shazow/urllib3549: https://github.com/shazow/urllib3/pull/549 .. _shazow/urllib3544: https://github.com/shazow/urllib3/pull/544 .. _shazow/urllib3540: https://github.com/shazow/urllib3/pull/540 .. _shazow/urllib3535: https://github.com/shazow/urllib3/pull/535 .. _shazow/urllib3534: https://github.com/shazow/urllib3/pull/534 .. _shazow/urllib3526: https://github.com/shazow/urllib3/pull/526

2.5.1

++++++++++++++++++

Behavioural Changes

  • Only catch HTTPErrors in raise_for_status (2382)

Bugfixes

  • Handle LocationParseError from urllib3 (2344)
  • Handle file-like object filenames that are not strings (2379)
  • Unbreak HTTPDigestAuth handler. Allow new nonces to be negotiated (2389)

    2.5.0

++++++++++++++++++

Improvements

  • Allow usage of urllib3's Retry object with HTTPAdapters (2216)
  • The iter_lines method on a response now accepts a delimiter with which to split the content (2295)

Behavioural Changes

  • Add deprecation warnings to functions in requests.utils that will be removed in 3.0 (2309)
  • Sessions used by the functional API are always closed (2326)
  • Restrict requests to HTTP/1.1 and HTTP/1.0 (stop accepting HTTP/0.9) (2323)

Bugfixes

  • Only parse the URL once (2353)
  • Allow Content-Length header to always be overridden (2332)
  • Properly handle files in HTTPDigestAuth (2333)
  • Cap redirect_cache size to prevent memory abuse (2299)
  • Fix HTTPDigestAuth handling of redirects after authenticating successfully (2253)
  • Fix crash with custom method parameter to Session.request (2317)
  • Fix how Link headers are parsed using the regular expression library (2271)

Documentation

  • Add more references for interlinking (2348)
  • Update CSS for theme (2290)
  • Update width of buttons and sidebar (2289)
  • Replace references of Gittip with Gratipay (2282)
  • Add link to changelog in sidebar (2273)

    2.4.3

++++++++++++++++++

Bugfixes

  • Unicode URL improvements for Python 2.
  • Re-order JSON param for backwards compat.
  • Automatically defrag authentication schemes from host/pass URIs. (2249 <https://github.com/kennethreitz/requests/issues/2249>_)

    2.4.2

++++++++++++++++++

Improvements

  • FINALLY! Add json parameter for uploads! (2258 <https://github.com/kennethreitz/requests/pull/2258>_)
  • Support for bytestring URLs on Python 3.x (2238 <https://github.com/kennethreitz/requests/pull/2238>_)

Bugfixes

  • Avoid getting stuck in a loop (2244 <https://github.com/kennethreitz/requests/pull/2244>_)
  • Multiple calls to iter* fail with unhelpful error. (2240 <https://github.com/kennethreitz/requests/issues/2240>, 2241 <https://github.com/kennethreitz/requests/issues/2241>)

Documentation

  • Correct redirection introduction (2245 <https://github.com/kennethreitz/requests/pull/2245/>_)
  • Added example of how to send multiple files in one request. (2227 <https://github.com/kennethreitz/requests/pull/2227/>_)
  • Clarify how to pass a custom set of CAs (2248 <https://github.com/kennethreitz/requests/pull/2248/>_)

    2.4.1

++++++++++++++++++

  • Now has a "security" package extras set, $ pip install requests[security]
  • Requests will now use Certifi if it is available.
  • Capture and re-raise urllib3 ProtocolError
  • Bugfix for responses that attempt to redirect to themselves forever (wtf?).

    2.4.0

++++++++++++++++++

Behavioral Changes

  • Connection: keep-alive header is now sent automatically.

Improvements

  • Support for connect timeouts! Timeout now accepts a tuple (connect, read) which is used to set individual connect and read timeouts.
  • Allow copying of PreparedRequests without headers/cookies.
  • Updated bundled urllib3 version.
  • Refactored settings loading from environment -- new Session.merge_environment_settings.
  • Handle socket errors in iter_content.

    2.3.0

++++++++++++++++++

API Changes

  • New Response property is_redirect, which is true when the library could have processed this response as a redirection (whether or not it actually did).
  • The timeout parameter now affects requests with both stream=True and stream=False equally.
  • The change in v2.0.0 to mandate explicit proxy schemes has been reverted. Proxy schemes now default to http://.
  • The CaseInsensitiveDict used for HTTP headers now behaves like a normal dictionary when references as string or viewed in the interpreter.

Bugfixes

  • No longer expose Authorization or Proxy-Authorization headers on redirect. Fix CVE-2014-1829 and CVE-2014-1830 respectively.
  • Authorization is re-evaluated each redirect.
  • On redirect, pass url as native strings.
  • Fall-back to autodetected encoding for JSON when Unicode detection fails.
  • Headers set to None on the Session are now correctly not sent.
  • Correctly honor decode_unicode even if it wasn't used earlier in the same response.
  • Stop advertising compress as a supported Content-Encoding.
  • The Response.history parameter is now always a list.
  • Many, many urllib3 bugfixes.

    2.2.1

++++++++++++++++++

Bugfixes

  • Fixes incorrect parsing of proxy credentials that contain a literal or encoded '' character.
  • Assorted urllib3 fixes.

    2.2.0

++++++++++++++++++

API Changes

  • New exception: ContentDecodingError. Raised instead of urllib3 DecodeError exceptions.

Bugfixes

  • Avoid many many exceptions from the buggy implementation of proxy_bypass on OS X in Python 2.6.
  • Avoid crashing when attempting to get authentication credentials from ~/.netrc when running as a user without a home directory.
  • Use the correct pool size for pools of connections to proxies.
  • Fix iteration of CookieJar objects.
  • Ensure that cookies are persisted over redirect.
  • Switch back to using chardet, since it has merged with charade.

    2.1.0

++++++++++++++++++

  • Updated CA Bundle, of course.
  • Cookies set on individual Requests through a Session (e.g. via Session.get()) are no longer persisted to the Session.
  • Clean up connections when we hit problems during chunked upload, rather than leaking them.
  • Return connections to the pool when a chunked upload is successful, rather than leaking it.
  • Match the HTTPbis recommendation for HTTP 301 redirects.
  • Prevent hanging when using streaming uploads and Digest Auth when a 401 is received.
  • Values of headers set by Requests are now always the native string type.
  • Fix previously broken SNI support.
  • Fix accessing HTTP proxies using proxy authentication.
  • Unencode HTTP Basic usernames and passwords extracted from URLs.
  • Support for IP address ranges for no_proxy environment variable
  • Parse headers correctly when users override the default Host: header.
  • Avoid munging the URL in case of case-sensitive servers.
  • Looser URL handling for non-HTTP/HTTPS urls.
  • Accept unicode methods in Python 2.6 and 2.7.
  • More resilient cookie handling.
  • Make Response objects pickleable.
  • Actually added MD5-sess to Digest Auth instead of pretending to like last time.
  • Updated internal urllib3.
  • Fixed Lukasa's lack of taste.

    2.0.1

++++++++++++++++++

  • Updated included CA Bundle with new mistrusts and automated process for the future
  • Added MD5-sess to Digest Auth
  • Accept per-file headers in multipart file POST messages.
  • Fixed: Don't send the full URL on CONNECT messages.
  • Fixed: Correctly lowercase a redirect scheme.
  • Fixed: Cookies not persisted when set via functional API.
  • Fixed: Translate urllib3 ProxyError into a requests ProxyError derived from ConnectionError.
  • Updated internal urllib3 and chardet.

    2.0.0

++++++++++++++++++

API Changes:

  • Keys in the Headers dictionary are now native strings on all Python versions, i.e. bytestrings on Python 2, unicode on Python 3.
  • Proxy URLs now must have an explicit scheme. A MissingSchema exception will be raised if they don't.
  • Timeouts now apply to read time if Stream=False.
  • RequestException is now a subclass of IOError, not RuntimeError.
  • Added new method to PreparedRequest objects: PreparedRequest.copy().
  • Added new method to Session objects: Session.update_request(). This method updates a Request object with the data (e.g. cookies) stored on the Session.
  • Added new method to Session objects: Session.prepare_request(). This method updates and prepares a Request object, and returns the corresponding PreparedRequest object.
  • Added new method to HTTPAdapter objects: HTTPAdapter.proxy_headers(). This should not be called directly, but improves the subclass interface.
  • httplib.IncompleteRead exceptions caused by incorrect chunked encoding will now raise a Requests ChunkedEncodingError instead.
  • Invalid percent-escape sequences now cause a Requests InvalidURL exception to be raised.
  • HTTP 208 no longer uses reason phrase "im_used". Correctly uses "already_reported".
  • HTTP 226 reason added ("im_used").

Bugfixes:

  • Vastly improved proxy support, including the CONNECT verb. Special thanks to the many contributors who worked towards this improvement.
  • Cookies are now properly managed when 401 authentication responses are received.
  • Chunked encoding fixes.
  • Support for mixed case schemes.
  • Better handling of streaming downloads.
  • Retrieve environment proxies from more locations.
  • Minor cookies fixes.
  • Improved redirect behaviour.
  • Improved streaming behaviour, particularly for compressed data.
  • Miscellaneous small Python 3 text encoding bugs.
  • .netrc no longer overrides explicit auth.
  • Cookies set by hooks are now correctly persisted on Sessions.
  • Fix problem with cookies that specify port numbers in their host field.
  • BytesIO can be used to perform streaming uploads.
  • More generous parsing of the no_proxy environment variable.
  • Non-string objects can be passed in data values alongside files.

    1.2.3

++++++++++++++++++

  • Simple packaging fix

    1.2.2

++++++++++++++++++

  • Simple packaging fix

    1.2.1

++++++++++++++++++

  • 301 and 302 redirects now change the verb to GET for all verbs, not just POST, improving browser compatibility.
  • Python 3.3.2 compatibility
  • Always percent-encode location headers
  • Fix connection adapter matching to be most-specific first
  • new argument to the default connection adapter for passing a block argument
  • prevent a KeyError when there's no link headers

    1.2.0

++++++++++++++++++

  • Fixed cookies on sessions and on requests
  • Significantly change how hooks are dispatched - hooks now receive all the arguments specified by the user when making a request so hooks can make a secondary request with the same parameters. This is especially necessary for authentication handler authors
  • certifi support was removed
  • Fixed bug where using OAuth 1 with body signature_type sent no data
  • Major proxy work thanks to Lukasa including parsing of proxy authentication from the proxy url
  • Fix DigestAuth handling too many 401s
  • Update vendored urllib3 to include SSL bug fixes
  • Allow keyword arguments to be passed to json.loads() via the Response.json() method
  • Don't send Content-Length header by default on GET or HEAD requests
  • Add elapsed attribute to Response objects to time how long a request took.
  • Fix RequestsCookieJar
  • Sessions and Adapters are now picklable, i.e., can be used with the multiprocessing library
  • Update charade to version 1.0.3

The change in how hooks are dispatched will likely cause a great deal of issues.

1.1.0

++++++++++++++++++

  • CHUNKED REQUESTS
  • Support for iterable response bodies
  • Assume servers persist redirect params
  • Allow explicit content types to be specified for file data
  • Make merge_kwargs case-insensitive when looking up keys

    1.0.3

++++++++++++++++++

  • Fix file upload encoding bug
  • Fix cookie behavior

    1.0.2

++++++++++++++++++

  • Proxy fix for HTTPAdapter.

    1.0.1

++++++++++++++++++

  • Cert verification exception bug.
  • Proxy fix for HTTPAdapter.

    1.0.0

++++++++++++++++++

  • Massive Refactor and Simplification
  • Switch to Apache 2.0 license
  • Swappable Connection Adapters
  • Mountable Connection Adapters
  • Mutable ProcessedRequest chain
  • /s/prefetch/stream
  • Removal of all configuration
  • Standard library logging
  • Make Response.json() callable, not property.
  • Usage of new charade project, which provides python 2 and 3 simultaneous chardet.
  • Removal of all hooks except 'response'
  • Removal of all authentication helpers (OAuth, Kerberos)

This is not a backwards compatible change.

0.14.2

+++++++++++++++++++

  • Improved mime-compatible JSON handling
  • Proxy fixes
  • Path hack fixes
  • Case-Insensitive Content-Encoding headers
  • Support for CJK parameters in form posts

    0.14.1

+++++++++++++++++++

  • Python 3.3 Compatibility
  • Simply default accept-encoding
  • Bugfixes

    0.14.0

++++++++++++++++++++

  • No more iter_content errors if already downloaded.

    0.13.9

+++++++++++++++++++

  • Fix for OAuth + POSTs
  • Remove exception eating from dispatch_hook
  • General bugfixes

    0.13.8

+++++++++++++++++++

  • Incredible Link header support :)

    0.13.7

+++++++++++++++++++

  • Support for (key, value) lists everywhere.
  • Digest Authentication improvements.
  • Ensure proxy exclusions work properly.
  • Clearer UnicodeError exceptions.
  • Automatic casting of URLs to strings (fURL and such)
  • Bugfixes.

    0.13.6

+++++++++++++++++++

  • Long awaited fix for hanging connections!

    0.13.5

+++++++++++++++++++

  • Packaging fix

    0.13.4

+++++++++++++++++++

  • GSSAPI/Kerberos authentication!
  • App Engine 2.7 Fixes!
  • Fix leaking connections (from urllib3 update)
  • OAuthlib path hack fix
  • OAuthlib URL parameters fix.

    0.13.3

+++++++++++++++++++

  • Use simplejson if available.
  • Do not hide SSLErrors behind Timeouts.
  • Fixed param handling with urls containing fragments.
  • Significantly improved information in User Agent.
  • client certificates are ignored when verify=False

    0.13.2

+++++++++++++++++++

  • Zero dependencies (once again)!
  • New: Response.reason
  • Sign querystring parameters in OAuth 1.0
  • Client certificates no longer ignored when verify=False
  • Add openSUSE certificate support

    0.13.1

+++++++++++++++++++

  • Allow passing a file or file-like object as data.
  • Allow hooks to return responses that indicate errors.
  • Fix Response.text and Response.json for body-less responses.

    0.13.0

+++++++++++++++++++

  • Removal of Requests.async in favor of grequests <https://github.com/kennethreitz/grequests>_
  • Allow disabling of cookie persistence.
  • New implementation of safe_mode
  • cookies.get now supports default argument
  • Session cookies not saved when Session.request is called with return_response=False
  • Env: no_proxy support.
  • RequestsCookieJar improvements.
  • Various bug fixes.

    0.12.1

+++++++++++++++++++

  • New Response.json property.
  • Ability to add string file uploads.
  • Fix out-of-range issue with iter_lines.
  • Fix iter_content default size.
  • Fix POST redirects containing files.

    0.12.0

+++++++++++++++++++

  • EXPERIMENTAL OAUTH SUPPORT!
  • Proper CookieJar-backed cookies interface with awesome dict-like interface.
  • Speed fix for non-iterated content chunks.
  • Move pre_request to a more usable place.
  • New pre_send hook.
  • Lazily encode data, params, files.
  • Load system Certificate Bundle if certify isn't available.
  • Cleanups, fixes.

    0.11.2

+++++++++++++++++++

  • Attempt to use the OS's certificate bundle if certifi isn't available.
  • Infinite digest auth redirect fix.
  • Multi-part file upload improvements.
  • Fix decoding of invalid %encodings in URLs.
  • If there is no content in a response don't throw an error the second time that content is attempted to be read.
  • Upload data on redirects.

    0.11.1

+++++++++++++++++++

  • POST redirects now break RFC to do what browsers do: Follow up with a GET.
  • New strict_mode configuration to disable new redirect behavior.

    0.11.0

+++++++++++++++++++

  • Private SSL Certificate support
  • Remove select.poll from Gevent monkeypatching
  • Remove redundant generator for chunked transfer encoding
  • Fix: Response.ok raises Timeout Exception in safe_mode

    0.10.8

+++++++++++++++++++

  • Generate chunked ValueError fix
  • Proxy configuration by environment variables
  • Simplification of iter_lines.
  • New trust_env configuration for disabling system/environment hints.
  • Suppress cookie errors.

    0.10.7

+++++++++++++++++++

  • encode_uri = False

    0.10.6

+++++++++++++++++++

  • Allow '=' in cookies.

    0.10.5

+++++++++++++++++++

  • Response body with 0 content-length fix.
  • New async.imap.
  • Don't fail on netrc.

    0.10.4

+++++++++++++++++++

  • Honor netrc.

    0.10.3

+++++++++++++++++++

  • HEAD requests don't follow redirects anymore.
  • raise_for_status() doesn't raise for 3xx anymore.
  • Make Session objects picklable.
  • ValueError for invalid schema URLs.

    0.10.2

+++++++++++++++++++

  • Vastly improved URL quoting.
  • Additional allowed cookie key values.
  • Attempted fix for "Too many open files" Error
  • Replace unicode errors on first pass, no need for second pass.
  • Append '/' to bare-domain urls before query insertion.
  • Exceptions now inherit from RuntimeError.
  • Binary uploads + auth fix.
  • Bugfixes.

    0.10.1

+++++++++++++++++++

  • PYTHON 3 SUPPORT!
  • Dropped 2.5 Support. (Backwards Incompatible)

    0.10.0

+++++++++++++++++++

  • Response.content is now bytes-only. (Backwards Incompatible)
  • New Response.text is unicode-only.
  • If no Response.encoding is specified and chardet is available, Response.text will guess an encoding.
  • Default to ISO-8859-1 (Western) encoding for "text" subtypes.
  • Removal of decode_unicode. (Backwards Incompatible)
  • New multiple-hooks system.
  • New Response.register_hook for registering hooks within the pipeline.
  • Response.url is now Unicode.

    0.9.3

++++++++++++++++++

  • SSL verify=False bugfix (apparent on windows machines).

    0.9.2

++++++++++++++++++

  • Asynchronous async.send method.
  • Support for proper chunk streams with boundaries.
  • session argument for Session classes.
  • Print entire hook tracebacks, not just exception instance.
  • Fix response.iter_lines from pending next line.
  • Fix but in HTTP-digest auth w/ URI having query strings.
  • Fix in Event Hooks section.
  • Urllib3 update.

    0.9.1

++++++++++++++++++

  • danger_mode for automatic Response.raise_for_status()
  • Response.iter_lines refactor

    0.9.0

++++++++++++++++++

  • verify ssl is default.

    0.8.9

++++++++++++++++++

  • Packaging fix.

    0.8.8

++++++++++++++++++

  • SSL CERT VERIFICATION!
  • Release of Cerifi: Mozilla's cert list.
  • New 'verify' argument for SSL requests.
  • Urllib3 update.

    0.8.7

++++++++++++++++++

  • iter_lines last-line truncation fix
  • Force safe_mode for async requests
  • Handle safe_mode exceptions more consistently
  • Fix iteration on null responses in safe_mode

    0.8.6

++++++++++++++++++

  • Socket timeout fixes.
  • Proxy Authorization support.

    0.8.5

++++++++++++++++++

  • Response.iter_lines!

    0.8.4

++++++++++++++++++

  • Prefetch bugfix.
  • Added license to installed version.

    0.8.3

++++++++++++++++++

  • Converted auth system to use simpler callable objects.
  • New session parameter to API methods.
  • Display full URL while logging.

    0.8.2

++++++++++++++++++

  • New Unicode decoding system, based on over-ridable Response.encoding.
  • Proper URL slash-quote handling.
  • Cookies with [, ], and _ allowed.

    0.8.1

++++++++++++++++++

  • URL Request path fix
  • Proxy fix.
  • Timeouts fix.

    0.8.0

++++++++++++++++++

  • Keep-alive support!
  • Complete removal of Urllib2
  • Complete removal of Poster
  • Complete removal of CookieJars
  • New ConnectionError raising
  • Safe_mode for error catching
  • prefetch parameter for request methods
  • OPTION method
  • Async pool size throttling
  • File uploads send real names
  • Vendored in urllib3

    0.7.6

++++++++++++++++++

  • Digest authentication bugfix (attach query data to path)

    0.7.5

++++++++++++++++++

  • Response.content = None if there was an invalid response.
  • Redirection auth handling.

    0.7.4

++++++++++++++++++

  • Session Hooks fix.

    0.7.3

++++++++++++++++++

  • Digest Auth fix.

    0.7.2

++++++++++++++++++

  • PATCH Fix.

    0.7.1

++++++++++++++++++

  • Move away from urllib2 authentication handling.
  • Fully Remove AuthManager, AuthObject, &c.
  • New tuple-based auth system with handler callbacks.

    0.7.0

++++++++++++++++++

  • Sessions are now the primary interface.
  • Deprecated InvalidMethodException.
  • PATCH fix.
  • New config system (no more global settings).

    0.6.6

++++++++++++++++++

  • Session parameter bugfix (params merging).

    0.6.5

++++++++++++++++++

  • Offline (fast) test suite.
  • Session dictionary argument merging.

    0.6.4

++++++++++++++++++

  • Automatic decoding of unicode, based on HTTP Headers.
  • New decode_unicode setting.
  • Removal of r.read/close methods.
  • New r.faw interface for advanced response usage.*
  • Automatic expansion of parameterized headers.

    0.6.3

++++++++++++++++++

  • Beautiful requests.async module, for making async requests w/ gevent.

    0.6.2

++++++++++++++++++

  • GET/HEAD obeys allow_redirects=False.

    0.6.1

++++++++++++++++++

  • Enhanced status codes experience \o/
  • Set a maximum number of redirects (settings.max_redirects)
  • Full Unicode URL support
  • Support for protocol-less redirects.
  • Allow for arbitrary request types.
  • Bugfixes

    0.6.0

++++++++++++++++++

  • New callback hook system
  • New persistent sessions object and context manager
  • Transparent Dict-cookie handling
  • Status code reference object
  • Removed Response.cached
  • Added Response.request
  • All args are kwargs
  • Relative redirect support
  • HTTPError handling improvements
  • Improved https testing
  • Bugfixes

    0.5.1

++++++++++++++++++

  • International Domain Name Support!
  • Access headers without fetching entire body (read())
  • Use lists as dicts for parameters
  • Add Forced Basic Authentication
  • Forced Basic is default authentication type
  • python-requests.org default User-Agent header
  • CaseInsensitiveDict lower-case caching
  • Response.history bugfix

    0.5.0

++++++++++++++++++

  • PATCH Support
  • Support for Proxies
  • HTTPBin Test Suite
  • Redirect Fixes
  • settings.verbose stream writing
  • Querystrings for all methods
  • URLErrors (Connection Refused, Timeout, Invalid URLs) are treated as explicitly raised r.requests.get('hwe://blah'); r.raise_for_status()

    0.4.1

++++++++++++++++++

  • Improved Redirection Handling
  • New 'allow_redirects' param for following non-GET/HEAD Redirects
  • Settings module refactoring

    0.4.0

++++++++++++++++++

  • Response.history: list of redirected responses
  • Case-Insensitive Header Dictionaries!
  • Unicode URLs

    0.3.4

++++++++++++++++++

  • Urllib2 HTTPAuthentication Recursion fix (Basic/Digest)
  • Internal Refactor
  • Bytes data upload Bugfix

    0.3.3

++++++++++++++++++

  • Request timeouts
  • Unicode url-encoded data
  • Settings context manager and module

    0.3.2

++++++++++++++++++

  • Automatic Decompression of GZip Encoded Content
  • AutoAuth Support for Tupled HTTP Auth

    0.3.1

++++++++++++++++++

  • Cookie Changes
  • Response.read()
  • Poster fix

    0.3.0

++++++++++++++++++

  • Automatic Authentication API Change
  • Smarter Query URL Parameterization
  • Allow file uploads and POST data together
  • New Authentication Manager System
    • Simpler Basic HTTP System
    • Supports all build-in urllib2 Auths
    • Allows for custom Auth Handlers

      0.2.4

++++++++++++++++++

  • Python 2.5 Support
  • PyPy-c v1.4 Support
  • Auto-Authentication tests
  • Improved Request object constructor

    0.2.3

++++++++++++++++++

  • New HTTPHandling Methods
    • Response.nonzero (false if bad HTTP Status)
    • Response.ok (True if expected HTTP Status)
    • Response.error (Logged HTTPError if bad HTTP Status)
    • Response.raise_for_status() (Raises stored HTTPError)

      0.2.2

++++++++++++++++++

  • Still handles request in the event of an HTTPError. (Issue 2)
  • Eventlet and Gevent Monkeypatch support.
  • Cookie Support (Issue 1)

    0.2.1

++++++++++++++++++

  • Added file attribute to POST and PUT requests for multipart-encode file uploads.
  • Added Request.url attribute for context and redirects

    0.2.0

++++++++++++++++++

  • Birth!

    0.0.1

++++++++++++++++++

  • Frustration
  • Conception

    coverage -> 4.2

4.2


  • Since concurrency=multiprocessing uses subprocesses, options specified on the coverage.py command line will not be communicated down to them. Only options in the configuration file will apply to the subprocesses. Previously, the options didn't apply to the subprocesses, but there was no indication. Now it is an error to use --concurrency=multiprocessing and other run-affecting options on the command line. This prevents failures like those reported in issue 495_.
  • Filtering the HTML report is now faster, thanks to Ville Skyttä.

.. _issue 495: https://bitbucket.org/ned/coveragepy/issues/495/branch-and-concurrency-are-conflicting

4.2b1


Work from the PyCon 2016 Sprints!

  • BACKWARD INCOMPATIBILITY: the coverage combine command now ignores an existing .coverage data file. It used to include that file in its combining. This caused confusing results, and extra tox "clean" steps. If you want the old behavior, use the new coverage combine --append option.
  • The concurrency option can now take multiple values, to support programs using multiprocessing and another library such as eventlet. This is only possible in the configuration file, not from the command line. The configuration file is the only way for sub-processes to all run with the same options. Fixes issue 484_. Thanks to Josh Williams for prototyping.
  • Using a concurrency setting of multiprocessing now implies --parallel so that the main program is measured similarly to the sub-processes.
  • When using automatic subprocess measurement, running coverage commands would create spurious data files. This is now fixed, thanks to diagnosis and testing by Dan Riti. Closes issue 492.
  • A new configuration option, report:sort, controls what column of the text report is used to sort the rows. Thanks to Dan Wandschneider, this closes issue 199_.
  • The HTML report has a more-visible indicator for which column is being sorted. Closes issue 298_, thanks to Josh Williams.
  • If the HTML report cannot find the source for a file, the message now suggests using the -i flag to allow the report to continue. Closes issue 231_, thanks, Nathan Land.
  • When reports are ignoring errors, there's now a warning if a file cannot be parsed, rather than being silently ignored. Closes issue 396_. Thanks, Matthew Boehm.
  • A new option for coverage debug is available: coverage debug config shows the current configuration. Closes issue 454_, thanks to Matthew Boehm.
  • Running coverage as a module (python -m coverage) no longer shows the program name as __main__.py. Fixes issue 478_. Thanks, Scott Belden.
  • The test_helpers module has been moved into a separate pip-installable package: unittest-mixins_.

.. _automatic subprocess measurement: http://coverage.readthedocs.io/en/latest/subprocess.html .. _issue 199: https://bitbucket.org/ned/coveragepy/issues/199/add-a-way-to-sort-the-text-report .. _issue 231: https://bitbucket.org/ned/coveragepy/issues/231/various-default-behavior-in-report-phase .. _issue 298: https://bitbucket.org/ned/coveragepy/issues/298/show-in-html-report-that-the-columns-are .. _issue 396: https://bitbucket.org/ned/coveragepy/issues/396/coverage-xml-shouldnt-bail-out-on-parse .. _issue 454: https://bitbucket.org/ned/coveragepy/issues/454/coverage-debug-config-should-be .. _issue 478: https://bitbucket.org/ned/coveragepy/issues/478/help-shows-silly-program-name-when-running .. _issue 484: https://bitbucket.org/ned/coveragepy/issues/484/multiprocessing-greenlet-concurrency .. _issue 492: https://bitbucket.org/ned/coveragepy/issues/492/subprocess-coverage-strange-detection-of .. _unittest-mixins: https://pypi.python.org/pypi/unittest-mixins

4.1


  • The internal attribute Reporter.file_reporters was removed in 4.1b3. It should have come has no surprise that there were third-party tools out there using that attribute. It has been restored, but with a deprecation warning.

    4.1b3


  • When running your program, execution can jump from an except X: line to some other line when an exception other than X happens. This jump is no longer considered a branch when measuring branch coverage.
  • When measuring branch coverage, yield statements that were never resumed were incorrectly marked as missing, as reported in issue 440_. This is now fixed.
  • During branch coverage of single-line callables like lambdas and generator expressions, coverage.py can now distinguish between them never being called, or being called but not completed. Fixes issue 90, issue 460 and issue 475_.
  • The HTML report now has a map of the file along the rightmost edge of the page, giving an overview of where the missed lines are. Thanks, Dmitry Shishov.
  • The HTML report now uses different monospaced fonts, favoring Consolas over Courier. Along the way, issue 472_ about not properly handling one-space indents was fixed. The index page also has slightly different styling, to try to make the clickable detail pages more apparent.
  • Missing branches reported with coverage report -m will now say ->exit for missed branches to the exit of a function, rather than a negative number. Fixes issue 469_.
  • coverage --help and coverage --version now mention which tracer is installed, to help diagnose problems. The docs mention which features need the C extension. (issue 479_)
  • Officially support PyPy 5.1, which required no changes, just updates to the docs.
  • The Coverage.report function had two parameters with non-None defaults, which have been changed. show_missing used to default to True, but now defaults to None. If you had been calling Coverage.report without specifying show_missing, you'll need to explicitly set it to True to keep the same behavior. skip_covered used to default to False. It is now None, which doesn't change the behavior. This fixes issue 485_.
  • It's never been possible to pass a namespace module to one of the analysis functions, but now at least we raise a more specific error message, rather than getting confused. (issue 456_)
  • The coverage.process_startup function now returns the Coverage instance it creates, as suggested in issue 481_.
  • Make a small tweak to how we compare threads, to avoid buggy custom comparison code in thread classes. (issue 245_)

.. _issue 90: https://bitbucket.org/ned/coveragepy/issues/90/lambda-expression-confuses-branch .. _issue 245: https://bitbucket.org/ned/coveragepy/issues/245/change-solution-for-issue-164 .. _issue 440: https://bitbucket.org/ned/coveragepy/issues/440/yielded-twisted-failure-marked-as-missed .. _issue 456: https://bitbucket.org/ned/coveragepy/issues/456/coverage-breaks-with-implicit-namespaces .. _issue 460: https://bitbucket.org/ned/coveragepy/issues/460/confusing-html-report-for-certain-partial .. _issue 469: https://bitbucket.org/ned/coveragepy/issues/469/strange-1-line-number-in-branch-coverage .. _issue 472: https://bitbucket.org/ned/coveragepy/issues/472/html-report-indents-incorrectly-for-one .. _issue 475: https://bitbucket.org/ned/coveragepy/issues/475/generator-expression-is-marked-as-not .. _issue 479: https://bitbucket.org/ned/coveragepy/issues/479/clarify-the-need-for-the-c-extension .. _issue 481: https://bitbucket.org/ned/coveragepy/issues/481/asyncioprocesspoolexecutor-tracing-not .. _issue 485: https://bitbucket.org/ned/coveragepy/issues/485/coveragereport-ignores-show_missing-and

4.1b2


  • Problems with the new branch measurement in 4.1 beta 1 were fixed:
    • Class docstrings were considered executable. Now they no longer are.
    • yield from and await were considered returns from functions, since they could tranfer control to the caller. This produced unhelpful "missing branch" reports in a number of circumstances. Now they no longer are considered returns.
    • In unusual situations, a missing branch to a negative number was reported. This has been fixed, closing issue 466_.
  • The XML report now produces correct package names for modules found in directories specified with source=. Fixes issue 465_.
  • coverage report won't produce trailing whitespace.

.. _issue 465: https://bitbucket.org/ned/coveragepy/issues/465/coveragexml-produces-package-names-with-an .. _issue 466: https://bitbucket.org/ned/coveragepy/issues/466/impossible-missed-branch-to-a-negative

4.1b1


  • Branch analysis has been rewritten: it used to be based on bytecode, but now uses AST analysis. This has changed a number of things:
    • More code paths are now considered runnable, especially in try/except structures. This may mean that coverage.py will identify more code paths as uncovered. This could either raise or lower your overall coverage number.
    • Python 3.5's async and await keywords are properly supported, fixing issue 434_.
    • Some long-standing branch coverage bugs were fixed:
    • issue 129_: functions with only a docstring for a body would incorrectly report a missing branch on the def line.
    • issue 212_: code in an except block could be incorrectly marked as a missing branch.
    • issue 146_: context managers (with statements) in a loop or try block could confuse the branch measurement, reporting incorrect partial branches.
    • issue 422_: in Python 3.5, an actual partial branch could be marked as complete.
  • Pragmas to disable coverage measurement can now be used on decorator lines, and they will apply to the entire function or class being decorated. This implements the feature requested in issue 131_.
  • Multiprocessing support is now available on Windows. Thanks, Rodrigue Cloutier.
  • Files with two encoding declarations are properly supported, fixing issue 453_. Thanks, Max Linke.
  • Non-ascii characters in regexes in the configuration file worked in 3.7, but stopped working in 4.0. Now they work again, closing issue 455_.
  • Form-feed characters would prevent accurate determination of the beginning of statements in the rest of the file. This is now fixed, closing issue 461_.

.. _issue 129: https://bitbucket.org/ned/coveragepy/issues/129/misleading-branch-coverage-of-empty .. _issue 131: https://bitbucket.org/ned/coveragepy/issues/131/pragma-on-a-decorator-line-should-affect .. _issue 146: https://bitbucket.org/ned/coveragepy/issues/146/context-managers-confuse-branch-coverage .. _issue 212: https://bitbucket.org/ned/coveragepy/issues/212/coverage-erroneously-reports-partial .. _issue 422: https://bitbucket.org/ned/coveragepy/issues/422/python35-partial-branch-marked-as-fully .. _issue 434: https://bitbucket.org/ned/coveragepy/issues/434/indexerror-in-python-35 .. _issue 453: https://bitbucket.org/ned/coveragepy/issues/453/source-code-encoding-can-only-be-specified .. _issue 455: https://bitbucket.org/ned/coveragepy/issues/455/unusual-exclusions-stopped-working-in .. _issue 461: https://bitbucket.org/ned/coveragepy/issues/461/multiline-asserts-need-too-many-pragma

4.0.3


  • Fixed a mysterious problem that manifested in different ways: sometimes hanging the process (issue 420), sometimes making database connections fail (issue 445).
  • The XML report now has correct <source> elements when using a --source= option somewhere besides the current directory. This fixes issue 439_. Thanks, Arcady Ivanov.
  • Fixed an unusual edge case of detecting source encodings, described in issue 443_.
  • Help messages that mention the command to use now properly use the actual command name, which might be different than "coverage". Thanks to Ben Finney, this closes issue 438_.

.. _issue 420: https://bitbucket.org/ned/coveragepy/issues/420/coverage-40-hangs-indefinitely-on-python27 .. _issue 438: https://bitbucket.org/ned/coveragepy/issues/438/parameterise-coverage-command-name .. _issue 439: https://bitbucket.org/ned/coveragepy/issues/439/incorrect-cobertura-file-sources-generated .. _issue 443: https://bitbucket.org/ned/coveragepy/issues/443/coverage-gets-confused-when-encoding .. _issue 445: https://bitbucket.org/ned/coveragepy/issues/445/django-app-cannot-connect-to-cassandra

4.0.2


  • More work on supporting unusually encoded source. Fixed issue 431_.
  • Files or directories with non-ASCII characters are now handled properly, fixing issue 432_.
  • Setting a trace function with sys.settrace was broken by a change in 4.0.1, as reported in issue 436_. This is now fixed.
  • Officially support PyPy 4.0, which required no changes, just updates to the docs.

.. _issue 431: https://bitbucket.org/ned/coveragepy/issues/431/couldnt-parse-python-file-with-cp1252 .. _issue 432: https://bitbucket.org/ned/coveragepy/issues/432/path-with-unicode-characters-various .. _issue 436: https://bitbucket.org/ned/coveragepy/issues/436/disabled-coverage-ctracer-may-rise-from

4.0.1


  • When combining data files, unreadable files will now generate a warning instead of failing the command. This is more in line with the older coverage.py v3.7.1 behavior, which silently ignored unreadable files. Prompted by issue 418_.
  • The --skip-covered option would skip reporting on 100% covered files, but also skipped them when calculating total coverage. This was wrong, it should only remove lines from the report, not change the final answer. This is now fixed, closing issue 423_.
  • In 4.0, the data file recorded a summary of the system on which it was run. Combined data files would keep all of those summaries. This could lead to enormous data files consisting of mostly repetitive useless information. That summary is now gone, fixing issue 415_. If you want summary information, get in touch, and we'll figure out a better way to do it.
  • Test suites that mocked os.path.exists would experience strange failures, due to coverage.py using their mock inadvertently. This is now fixed, closing issue 416_.
  • Importing a __init__ module explicitly would lead to an error: AttributeError: 'module' object has no attribute '__path__', as reported in issue 410_. This is now fixed.
  • Code that uses sys.settrace(sys.gettrace()) used to incur a more than 2x speed penalty. Now there's no penalty at all. Fixes issue 397_.
  • Pyexpat C code will no longer be recorded as a source file, fixing issue 419_.
  • The source kit now contains all of the files needed to have a complete source tree, re-fixing issue 137 and closing issue 281.

.. _issue 281: https://bitbucket.org/ned/coveragepy/issues/281/supply-scripts-for-testing-in-the .. _issue 397: https://bitbucket.org/ned/coveragepy/issues/397/stopping-and-resuming-coverage-with .. _issue 410: https://bitbucket.org/ned/coveragepy/issues/410/attributeerror-module-object-has-no .. _issue 415: https://bitbucket.org/ned/coveragepy/issues/415/repeated-coveragedataupdates-cause .. _issue 416: https://bitbucket.org/ned/coveragepy/issues/416/mocking-ospathexists-causes-failures .. _issue 418: https://bitbucket.org/ned/coveragepy/issues/418/json-parse-error .. _issue 419: https://bitbucket.org/ned/coveragepy/issues/419/nosource-no-source-for-code-path-to-c .. _issue 423: https://bitbucket.org/ned/coveragepy/issues/423/skip_covered-changes-reported-total

4.0


4.0b3


  • Reporting on an unmeasured file would fail with a traceback. This is now fixed, closing issue 403_.
  • The Jenkins ShiningPanda plugin looks for an obsolete file name to find the HTML reports to publish, so it was failing under coverage.py 4.0. Now we create that file if we are running under Jenkins, to keep things working smoothly. issue 404_.
  • Kits used to include tests and docs, but didn't install them anywhere, or provide all of the supporting tools to make them useful. Kits no longer include tests and docs. If you were using them from the older packages, get in touch and help me understand how.

.. _issue 403: https://bitbucket.org/ned/coveragepy/issues/403/hasherupdate-fails-with-typeerror-nonetype .. _issue 404: https://bitbucket.org/ned/coveragepy/issues/404/shiningpanda-jenkins-plugin-cant-find-html

4.0b2


  • 4.0b1 broke --append creating new data files. This is now fixed, closing issue 392_.
  • py.test --cov can write empty data, then touch files due to --source, which made coverage.py mistakenly force the data file to record lines instead of arcs. This would lead to a "Can't combine line data with arc data" error message. This is now fixed, and changed some method names in the CoverageData interface. Fixes issue 399_.
  • CoverageData.read_fileobj and CoverageData.write_fileobj replace the .read and .write methods, and are now properly inverses of each other.
  • When using report --skip-covered, a message will now be included in the report output indicating how many files were skipped, and if all files are skipped, coverage.py won't accidentally scold you for having no data to report. Thanks, Krystian Kichewko.
  • A new conversion utility has been added: python -m coverage.pickle2json will convert v3.x pickle data files to v4.x JSON data files. Thanks, Alexander Todorov. Closes issue 395_.
  • A new version identifier is available, coverage.version_info, a plain tuple of values similar to sys.version_info_.

.. _issue 392: https://bitbucket.org/ned/coveragepy/issues/392/run-append-doesnt-create-coverage-file .. _issue 395: https://bitbucket.org/ned/coveragepy/issues/395/rfe-read-pickled-files-as-well-for .. _issue 399: https://bitbucket.org/ned/coveragepy/issues/399/coverageexception-cant-combine-line-data .. _sys.version_info: https://docs.python.org/3/library/sys.htmlsys.version_info

4.0b1


  • Coverage.py is now licensed under the Apache 2.0 license. See NOTICE.txt for details. Closes issue 313_.
  • The data storage has been completely revamped. The data file is now JSON-based instead of a pickle, closing issue 236_. The CoverageData class is now a public supported documented API to the data file.
  • A new configuration option, [run] note, lets you set a note that will be stored in the runs section of the data file. You can use this to annotate the data file with any information you like.
  • Unrecognized configuration options will now print an error message and stop coverage.py. This should help prevent configuration mistakes from passing silently. Finishes issue 386_.
  • In parallel mode, coverage erase will now delete all of the data files, fixing issue 262_.
  • Coverage.py now accepts a directory name for coverage run and will run a __main__.py found there, just like Python will. Fixes issue 252_. Thanks, Dmitry Trofimov.
  • The XML report now includes a missing-branches attribute. Thanks, Steve Peak. This is not a part of the Cobertura DTD, so the XML report no longer references the DTD.
  • Missing branches in the HTML report now have a bit more information in the right-hand annotations. Hopefully this will make their meaning clearer.
  • All the reporting functions now behave the same if no data had been collected, exiting with a status code of 1. Fixed fail_under to be applied even when the report is empty. Thanks, Ionel Cristian Mărieș.
  • Plugins are now initialized differently. Instead of looking for a class called Plugin, coverage.py looks for a function called coverage_init.
  • A file-tracing plugin can now ask to have built-in Python reporting by returning "python" from its file_reporter() method.
  • Code that was executed with exec would be mis-attributed to the file that called it. This is now fixed, closing issue 380_.
  • The ability to use item access on Coverage.config (introduced in 4.0a2) has been changed to a more explicit Coverage.get_option and Coverage.set_option API.
  • The Coverage.use_cache method is no longer supported.
  • The private method Coverage._harvest_data is now called Coverage.get_data, and returns the CoverageData containing the collected data.
  • The project is consistently referred to as "coverage.py" throughout the code and the documentation, closing issue 275_.
  • Combining data files with an explicit configuration file was broken in 4.0a6, but now works again, closing issue 385_.
  • coverage combine now accepts files as well as directories.
  • The speed is back to 3.7.1 levels, after having slowed down due to plugin support, finishing up issue 387_.

.. _issue 236: https://bitbucket.org/ned/coveragepy/issues/236/pickles-are-bad-and-you-should-feel-bad .. _issue 252: https://bitbucket.org/ned/coveragepy/issues/252/coverage-wont-run-a-program-with .. _issue 262: https://bitbucket.org/ned/coveragepy/issues/262/when-parallel-true-erase-should-erase-all .. _issue 275: https://bitbucket.org/ned/coveragepy/issues/275/refer-consistently-to-project-as-coverage .. _issue 313: https://bitbucket.org/ned/coveragepy/issues/313/add-license-file-containing-2-3-or-4 .. _issue 380: https://bitbucket.org/ned/coveragepy/issues/380/code-executed-by-exec-excluded-from .. _issue 385: https://bitbucket.org/ned/coveragepy/issues/385/coverage-combine-doesnt-work-with-rcfile .. _issue 386: https://bitbucket.org/ned/coveragepy/issues/386/error-on-unrecognised-configuration .. _issue 387: https://bitbucket.org/ned/coveragepy/issues/387/performance-degradation-from-371-to-40

.. 40 issues closed in 4.0 below here

4.0a6


  • Python 3.5b2 and PyPy 2.6.0 are supported.
  • The original module-level function interface to coverage.py is no longer supported. You must now create a coverage.Coverage object, and use methods on it.
  • The coverage combine command now accepts any number of directories as arguments, and will combine all the data files from those directories. This means you don't have to copy the files to one directory before combining. Thanks, Christine Lytwynec. Finishes issue 354_.
  • Branch coverage couldn't properly handle certain extremely long files. This is now fixed (issue 359_).
  • Branch coverage didn't understand yield statements properly. Mickie Betz persisted in pursuing this despite Ned's pessimism. Fixes issue 308 and issue 324.
  • The COVERAGE_DEBUG environment variable can be used to set the [run] debug configuration option to control what internal operations are logged.
  • HTML reports were truncated at formfeed characters. This is now fixed (issue 360). It's always fun when the problem is due to a bug in the Python standard library <http://bugs.python.org/issue19035>.
  • Files with incorrect encoding declaration comments are no longer ignored by the reporting commands, fixing issue 351_.
  • HTML reports now include a timestamp in the footer, closing issue 299_. Thanks, Conrad Ho.
  • HTML reports now begrudgingly use double-quotes rather than single quotes, because there are "software engineers" out there writing tools that read HTML and somehow have no idea that single quotes exist. Capitulates to the absurd issue 361_. Thanks, Jon Chappell.
  • The coverage annotate command now handles non-ASCII characters properly, closing issue 363_. Thanks, Leonardo Pistone.
  • Drive letters on Windows were not normalized correctly, now they are. Thanks, Ionel Cristian Mărieș.
  • Plugin support had some bugs fixed, closing issue 374 and issue 375. Thanks, Stefan Behnel.

.. _issue 299: https://bitbucket.org/ned/coveragepy/issue/299/inserted-created-on-yyyy-mm-dd-hh-mm-in .. _issue 308: https://bitbucket.org/ned/coveragepy/issue/308/yield-lambda-branch-coverage .. _issue 324: https://bitbucket.org/ned/coveragepy/issue/324/yield-in-loop-confuses-branch-coverage .. _issue 351: https://bitbucket.org/ned/coveragepy/issue/351/files-with-incorrect-encoding-are-ignored .. _issue 354: https://bitbucket.org/ned/coveragepy/issue/354/coverage-combine-should-take-a-list-of .. _issue 359: https://bitbucket.org/ned/coveragepy/issue/359/xml-report-chunk-error .. _issue 360: https://bitbucket.org/ned/coveragepy/issue/360/html-reports-get-confused-by-l-in-the-code .. _issue 361: https://bitbucket.org/ned/coveragepy/issue/361/use-double-quotes-in-html-output-to .. _issue 363: https://bitbucket.org/ned/coveragepy/issue/363/annotate-command-hits-unicode-happy-fun .. _issue 374: https://bitbucket.org/ned/coveragepy/issue/374/c-tracer-lookups-fail-in .. _issue 375: https://bitbucket.org/ned/coveragepy/issue/375/ctracer_handle_return-reads-byte-code

4.0a5


  • Plugin support is now implemented in the C tracer instead of the Python tracer. This greatly improves the speed of tracing projects using plugins.
  • Coverage.py now always adds the current directory to sys.path, so that plugins can import files in the current directory (issue 358_).
  • If the config_file argument to the Coverage constructor is specified as ".coveragerc", it is treated as if it were True. This means setup.cfg is also examined, and a missing file is not considered an error (issue 357_).
  • Wildly experimental: support for measuring processes started by the multiprocessing module. To use, set --concurrency=multiprocessing, either on the command line or in the .coveragerc file (issue 117_). Thanks, Eduardo Schettino. Currently, this does not work on Windows.
  • A new warning is possible, if a desired file isn't measured because it was imported before coverage.py was started (issue 353_).
  • The coverage.process_startup function now will start coverage measurement only once, no matter how many times it is called. This fixes problems due to unusual virtualenv configurations (issue 340_).
  • Added 3.5.0a1 to the list of supported CPython versions.

.. _issue 117: https://bitbucket.org/ned/coveragepy/issue/117/enable-coverage-measurement-of-code-run-by .. _issue 340: https://bitbucket.org/ned/coveragepy/issue/340/keyerror-subpy .. _issue 353: https://bitbucket.org/ned/coveragepy/issue/353/40a3-introduces-an-unexpected-third-case .. _issue 357: https://bitbucket.org/ned/coveragepy/issue/357/behavior-changed-when-coveragerc-is .. _issue 358: https://bitbucket.org/ned/coveragepy/issue/358/all-coverage-commands-should-adjust

4.0a4


  • Plugins can now provide sys_info for debugging output.
  • Started plugins documentation.
  • Prepared to move the docs to readthedocs.org.

    4.0a3


  • Reports now use file names with extensions. Previously, a report would describe a/b/c.py as "a/b/c". Now it is shown as "a/b/c.py". This allows for better support of non-Python files, and also fixed issue 69_.
  • The XML report now reports each directory as a package again. This was a bad regression, I apologize. This was reported in issue 235_, which is now fixed.
  • A new configuration option for the XML report: [xml] package_depth controls which directories are identified as packages in the report. Directories deeper than this depth are not reported as packages. The default is that all directories are reported as packages. Thanks, Lex Berezhny.
  • When looking for the source for a frame, check if the file exists. On Windows, .pyw files are no longer recorded as .py files. Along the way, this fixed issue 290_.
  • Empty files are now reported as 100% covered in the XML report, not 0% covered (issue 345_).
  • Regexes in the configuration file are now compiled as soon as they are read, to provide error messages earlier (issue 349_).

.. _issue 69: https://bitbucket.org/ned/coveragepy/issue/69/coverage-html-overwrite-files-that-doesnt .. _issue 235: https://bitbucket.org/ned/coveragepy/issue/235/package-name-is-missing-in-xml-report .. _issue 290: https://bitbucket.org/ned/coveragepy/issue/290/running-programmatically-with-pyw-files .. _issue 345: https://bitbucket.org/ned/coveragepy/issue/345/xml-reports-line-rate-0-for-empty-files .. _issue 349: https://bitbucket.org/ned/coveragepy/issue/349/bad-regex-in-config-should-get-an-earlier

4.0a2


  • Officially support PyPy 2.4, and PyPy3 2.4. Drop support for CPython 3.2 and older versions of PyPy. The code won't work on CPython 3.2. It will probably still work on older versions of PyPy, but I'm not testing against them.
  • Plugins!
  • The original command line switches (-x to run a program, etc) are no longer supported.
  • A new option: coverage report --skip-covered will reduce the number of files reported by skipping files with 100% coverage. Thanks, Krystian Kichewko. This means that empty __init__.py files will be skipped, since they are 100% covered, closing issue 315_.
  • You can now specify the --fail-under option in the .coveragerc file as the [report] fail_under option. This closes issue 314_.
  • The COVERAGE_OPTIONS environment variable is no longer supported. It was a hack for --timid before configuration files were available.
  • The HTML report now has filtering. Type text into the Filter box on the index page, and only modules with that text in the name will be shown. Thanks, Danny Allen.
  • The textual report and the HTML report used to report partial branches differently for no good reason. Now the text report's "missing branches" column is a "partial branches" column so that both reports show the same numbers. This closes issue 342_.
  • If you specify a --rcfile that cannot be read, you will get an error message. Fixes issue 343_.
  • The --debug switch can now be used on any command.
  • You can now programmatically adjust the configuration of coverage.py by setting items on Coverage.config after construction.
  • A module run with -m can be used as the argument to --source, fixing issue 328_. Thanks, Buck Evan.
  • The regex for matching exclusion pragmas has been fixed to allow more kinds of whitespace, fixing issue 334_.
  • Made some PyPy-specific tweaks to improve speed under PyPy. Thanks, Alex Gaynor.
  • In some cases, with a source file missing a final newline, coverage.py would count statements incorrectly. This is now fixed, closing issue 293_.
  • The status.dat file that HTML reports use to avoid re-creating files that haven't changed is now a JSON file instead of a pickle file. This obviates issue 287 and issue 237.

.. _issue 237: https://bitbucket.org/ned/coveragepy/issue/237/htmlcov-with-corrupt-statusdat .. _issue 287: https://bitbucket.org/ned/coveragepy/issue/287/htmlpy-doesnt-specify-pickle-protocol .. _issue 293: https://bitbucket.org/ned/coveragepy/issue/293/number-of-statement-detection-wrong-if-no .. _issue 314: https://bitbucket.org/ned/coveragepy/issue/314/fail_under-param-not-working-in-coveragerc .. _issue 315: https://bitbucket.org/ned/coveragepy/issue/315/option-to-omit-empty-files-eg-__init__py .. _issue 328: https://bitbucket.org/ned/coveragepy/issue/328/misbehavior-in-run-source .. _issue 334: https://bitbucket.org/ned/coveragepy/issue/334/pragma-not-recognized-if-tab-character .. _issue 342: https://bitbucket.org/ned/coveragepy/issue/342/console-and-html-coverage-reports-differ .. _issue 343: https://bitbucket.org/ned/coveragepy/issue/343/an-explicitly-named-non-existent-config

4.0a1


  • Python versions supported are now CPython 2.6, 2.7, 3.2, 3.3, and 3.4, and PyPy 2.2.
  • Gevent, eventlet, and greenlet are now supported, closing issue 149_. The concurrency setting specifies the concurrency library in use. Huge thanks to Peter Portante for initial implementation, and to Joe Jevnik for the final insight that completed the work.
  • Options are now also read from a setup.cfg file, if any. Sections are prefixed with "coverage:", so the [run] options will be read from the [coverage:run] section of setup.cfg. Finishes issue 304_.
  • The report -m command can now show missing branches when reporting on branch coverage. Thanks, Steve Leonard. Closes issue 230_.
  • The XML report now contains a <source> element, fixing issue 94_. Thanks Stan Hu.
  • The class defined in the coverage module is now called Coverage instead of coverage, though the old name still works, for backward compatibility.
  • The fail-under value is now rounded the same as reported results, preventing paradoxical results, fixing issue 284_.
  • The XML report will now create the output directory if need be, fixing issue 285_. Thanks, Chris Rose.
  • HTML reports no longer raise UnicodeDecodeError if a Python file has undecodable characters, fixing issue 303 and issue 331.
  • The annotate command will now annotate all files, not just ones relative to the current directory, fixing issue 57_.
  • The coverage module no longer causes deprecation warnings on Python 3.4 by importing the imp module, fixing issue 305_.
  • Encoding declarations in source files are only considered if they are truly comments. Thanks, Anthony Sottile.

.. _issue 57: https://bitbucket.org/ned/coveragepy/issue/57/annotate-command-fails-to-annotate-many .. _issue 94: https://bitbucket.org/ned/coveragepy/issue/94/coverage-xml-doesnt-produce-sources .. _issue 149: https://bitbucket.org/ned/coveragepy/issue/149/coverage-gevent-looks-broken .. _issue 230: https://bitbucket.org/ned/coveragepy/issue/230/show-line-no-for-missing-branches-in .. _issue 284: https://bitbucket.org/ned/coveragepy/issue/284/fail-under-should-show-more-precision .. _issue 285: https://bitbucket.org/ned/coveragepy/issue/285/xml-report-fails-if-output-file-directory .. _issue 303: https://bitbucket.org/ned/coveragepy/issue/303/unicodedecodeerror .. _issue 304: https://bitbucket.org/ned/coveragepy/issue/304/attempt-to-get-configuration-from-setupcfg .. _issue 305: https://bitbucket.org/ned/coveragepy/issue/305/pendingdeprecationwarning-the-imp-module .. _issue 331: https://bitbucket.org/ned/coveragepy/issue/331/failure-of-encoding-detection-on-python2

3.7.1


  • Improved the speed of HTML report generation by about 20%.
  • Fixed the mechanism for finding OS-installed static files for the HTML report so that it will actually find OS-installed static files.

    3.7


  • Added the --debug switch to coverage run. It accepts a list of options indicating the type of internal activity to log to stderr.
  • Improved the branch coverage facility, fixing issue 92 and issue 175.
  • Running code with coverage run -m now behaves more like Python does, setting sys.path properly, which fixes issue 207 and issue 242.
  • Coverage.py can now run .pyc files directly, closing issue 264_.
  • Coverage.py properly supports .pyw files, fixing issue 261_.
  • Omitting files within a tree specified with the source option would cause them to be incorrectly marked as unexecuted, as described in issue 218_. This is now fixed.
  • When specifying paths to alias together during data combining, you can now specify relative paths, fixing issue 267_.
  • Most file paths can now be specified with username expansion (~/src, or ~build/src, for example), and with environment variable expansion (build/$BUILDNUM/src).
  • Trying to create an XML report with no files to report on, would cause a ZeroDivideError, but no longer does, fixing issue 250_.
  • When running a threaded program under the Python tracer, coverage.py no longer issues a spurious warning about the trace function changing: "Trace function changed, measurement is likely wrong: None." This fixes issue 164_.
  • Static files necessary for HTML reports are found in system-installed places, to ease OS-level packaging of coverage.py. Closes issue 259_.
  • Source files with encoding declarations, but a blank first line, were not decoded properly. Now they are. Thanks, Roger Hu.
  • The source kit now includes the __main__.py file in the root coverage directory, fixing issue 255_.

.. _issue 92: https://bitbucket.org/ned/coveragepy/issue/92/finally-clauses-arent-treated-properly-in .. _issue 164: https://bitbucket.org/ned/coveragepy/issue/164/trace-function-changed-warning-when-using .. _issue 175: https://bitbucket.org/ned/coveragepy/issue/175/branch-coverage-gets-confused-in-certain .. _issue 207: https://bitbucket.org/ned/coveragepy/issue/207/run-m-cannot-find-module-or-package-in .. _issue 242: https://bitbucket.org/ned/coveragepy/issue/242/running-a-two-level-package-doesnt-work .. _issue 218: https://bitbucket.org/ned/coveragepy/issue/218/run-command-does-not-respect-the-omit-flag .. _issue 250: https://bitbucket.org/ned/coveragepy/issue/250/uncaught-zerodivisionerror-when-generating .. _issue 255: https://bitbucket.org/ned/coveragepy/issue/255/directory-level-__main__py-not-included-in .. _issue 259: https://bitbucket.org/ned/coveragepy/issue/259/allow-use-of-system-installed-third-party .. _issue 261: https://bitbucket.org/ned/coveragepy/issue/261/pyw-files-arent-reported-properly .. _issue 264: https://bitbucket.org/ned/coveragepy/issue/264/coverage-wont-run-pyc-files .. _issue 267: https://bitbucket.org/ned/coveragepy/issue/267/relative-path-aliases-dont-work

3.6


  • Added a page to the docs about troublesome situations, closing issue 226, and added some info to the TODO file, closing issue 227.

.. _issue 226: https://bitbucket.org/ned/coveragepy/issue/226/make-readme-section-to-describe-when .. _issue 227: https://bitbucket.org/ned/coveragepy/issue/227/update-todo

3.6b3


  • Beta 2 broke the nose plugin. It's fixed again, closing issue 224_.

.. _issue 224: https://bitbucket.org/ned/coveragepy/issue/224/36b2-breaks-nosexcover

3.6b2


  • Coverage.py runs on Python 2.3 and 2.4 again. It was broken in 3.6b1.
  • The C extension is optionally compiled using a different more widely-used technique, taking another stab at fixing issue 80_ once and for all.
  • Combining data files would create entries for phantom files if used with source and path aliases. It no longer does.
  • debug sys now shows the configuration file path that was read.
  • If an oddly-behaved package claims that code came from an empty-string file name, coverage.py no longer associates it with the directory name, fixing issue 221_.

.. _issue 221: https://bitbucket.org/ned/coveragepy/issue/221/coveragepy-incompatible-with-pyratemp

3.6b1


  • Wildcards in include= and omit= arguments were not handled properly in reporting functions, though they were when running. Now they are handled uniformly, closing issue 143 and issue 163. NOTE: it is possible that your configurations may now be incorrect. If you use include or omit during reporting, whether on the command line, through the API, or in a configuration file, please check carefully that you were not relying on the old broken behavior.
  • The report, html, and xml commands now accept a --fail-under switch that indicates in the exit status whether the coverage percentage was less than a particular value. Closes issue 139_.
  • The reporting functions coverage.report(), coverage.html_report(), and coverage.xml_report() now all return a float, the total percentage covered measurement.
  • The HTML report's title can now be set in the configuration file, with the --title switch on the command line, or via the API.
  • Configuration files now support substitution of environment variables, using syntax like ${WORD}. Closes issue 97_.
  • Embarrassingly, the [xml] output= setting in the .coveragerc file simply didn't work. Now it does.
  • The XML report now consistently uses file names for the file name attribute, rather than sometimes using module names. Fixes issue 67_. Thanks, Marcus Cobden.
  • Coverage percentage metrics are now computed slightly differently under branch coverage. This means that completely unexecuted files will now correctly have 0% coverage, fixing issue 156_. This also means that your total coverage numbers will generally now be lower if you are measuring branch coverage.
  • When installing, now in addition to creating a "coverage" command, two new aliases are also installed. A "coverage2" or "coverage3" command will be created, depending on whether you are installing in Python 2.x or 3.x. A "coverage-X.Y" command will also be created corresponding to your specific version of Python. Closes issue 111_.
  • The coverage.py installer no longer tries to bootstrap setuptools or Distribute. You must have one of them installed first, as issue 202_ recommended.
  • The coverage.py kit now includes docs (closing issue 137_) and tests.
  • On Windows, files are now reported in their correct case, fixing issue 89 and issue 203.
  • If a file is missing during reporting, the path shown in the error message is now correct, rather than an incorrect path in the current directory. Fixes issue 60_.
  • Running an HTML report in Python 3 in the same directory as an old Python 2 HTML report would fail with a UnicodeDecodeError. This issue (issue 193_) is now fixed.
  • Fixed yet another error trying to parse non-Python files as Python, this time an IndentationError, closing issue 82_ for the fourth time...
  • If coverage xml fails because there is no data to report, it used to create a zero-length XML file. Now it doesn't, fixing issue 210_.
  • Jython files now work with the --source option, fixing issue 100_.
  • Running coverage.py under a debugger is unlikely to work, but it shouldn't fail with "TypeError: 'NoneType' object is not iterable". Fixes issue 201_.
  • On some Linux distributions, when installed with the OS package manager, coverage.py would report its own code as part of the results. Now it won't, fixing issue 214_, though this will take some time to be repackaged by the operating systems.
  • Docstrings for the legacy singleton methods are more helpful. Thanks Marius Gedminas. Closes issue 205_.
  • The pydoc tool can now show documentation for the class coverage.coverage. Closes issue 206_.
  • Added a page to the docs about contributing to coverage.py, closing issue 171_.
  • When coverage.py ended unsuccessfully, it may have reported odd errors like &#39;NoneType&#39; object has no attribute &#39;isabs&#39;. It no longer does, so kiss issue 153_ goodbye.

.. _issue 60: https://bitbucket.org/ned/coveragepy/issue/60/incorrect-path-to-orphaned-pyc-files .. _issue 67: https://bitbucket.org/ned/coveragepy/issue/67/xml-report-filenames-may-be-generated .. _issue 89: https://bitbucket.org/ned/coveragepy/issue/89/on-windows-all-packages-are-reported-in .. _issue 97: https://bitbucket.org/ned/coveragepy/issue/97/allow-environment-variables-to-be .. _issue 100: https://bitbucket.org/ned/coveragepy/issue/100/source-directive-doesnt-work-for-packages .. _issue 111: https://bitbucket.org/ned/coveragepy/issue/111/when-installing-coverage-with-pip-not .. _issue 137: https://bitbucket.org/ned/coveragepy/issue/137/provide-docs-with-source-distribution .. _issue 139: https://bitbucket.org/ned/coveragepy/issue/139/easy-check-for-a-certain-coverage-in-tests .. _issue 143: https://bitbucket.org/ned/coveragepy/issue/143/omit-doesnt-seem-to-work-in-coverage .. _issue 153: https://bitbucket.org/ned/coveragepy/issue/153/non-existent-filename-triggers .. _issue 156: https://bitbucket.org/ned/coveragepy/issue/156/a-completely-unexecuted-file-shows-14 .. _issue 163: https://bitbucket.org/ned/coveragepy/issue/163/problem-with-include-and-omit-filename .. _issue 171: https://bitbucket.org/ned/coveragepy/issue/171/how-to-contribute-and-run-tests .. _issue 193: https://bitbucket.org/ned/coveragepy/issue/193/unicodedecodeerror-on-htmlpy .. _issue 201: https://bitbucket.org/ned/coveragepy/issue/201/coverage-using-django-14-with-pydb-on .. _issue 202: https://bitbucket.org/ned/coveragepy/issue/202/get-rid-of-ez_setuppy-and .. _issue 203: https://bitbucket.org/ned/coveragepy/issue/203/duplicate-filenames-reported-when-filename .. _issue 205: https://bitbucket.org/ned/coveragepy/issue/205/make-pydoc-coverage-more-friendly .. _issue 206: https://bitbucket.org/ned/coveragepy/issue/206/pydoc-coveragecoverage-fails-with-an-error .. _issue 210: https://bitbucket.org/ned/coveragepy/issue/210/if-theres-no-coverage-data-coverage-xml .. _issue 214: https://bitbucket.org/ned/coveragepy/issue/214/coveragepy-measures-itself-on-precise

3.5.3


  • Line numbers in the HTML report line up better with the source lines, fixing issue 197_, thanks Marius Gedminas.
  • When specifying a directory as the source= option, the directory itself no longer needs to have a __init__.py file, though its sub-directories do, to be considered as source files.
  • Files encoded as UTF-8 with a BOM are now properly handled, fixing issue 179_. Thanks, Pablo Carballo.
  • Fixed more cases of non-Python files being reported as Python source, and then not being able to parse them as Python. Closes issue 82_ (again). Thanks, Julian Berman.
  • Fixed memory leaks under Python 3, thanks, Brett Cannon. Closes issue 147_.
  • Optimized .pyo files may not have been handled correctly, issue 195_. Thanks, Marius Gedminas.
  • Certain unusually named file paths could have been mangled during reporting, issue 194_. Thanks, Marius Gedminas.
  • Try to do a better job of the impossible task of detecting when we can't build the C extension, fixing issue 183_.
  • Testing is now done with tox_, thanks, Marc Abramowitz.

.. _issue 147: https://bitbucket.org/ned/coveragepy/issue/147/massive-memory-usage-by-ctracer .. _issue 179: https://bitbucket.org/ned/coveragepy/issue/179/htmlreporter-fails-when-source-file-is .. _issue 183: https://bitbucket.org/ned/coveragepy/issue/183/install-fails-for-python-23 .. _issue 194: https://bitbucket.org/ned/coveragepy/issue/194/filelocatorrelative_filename-could-mangle .. _issue 195: https://bitbucket.org/ned/coveragepy/issue/195/pyo-file-handling-in-codeunit .. _issue 197: https://bitbucket.org/ned/coveragepy/issue/197/line-numbers-in-html-report-do-not-align .. _tox: http://tox.readthedocs.org/

3.5.2


3.5.2.b1

3.5.2b1


  • The HTML report has slightly tweaked controls: the buttons at the top of the page are color-coded to the source lines they affect.
  • Custom CSS can be applied to the HTML report by specifying a CSS file as the extra_css configuration value in the [html] section.
  • Source files with custom encodings declared in a comment at the top are now properly handled during reporting on Python 2. Python 3 always handled them properly. This fixes issue 157_.
  • Backup files left behind by editors are no longer collected by the source= option, fixing issue 168_.
  • If a file doesn't parse properly as Python, we don't report it as an error if the file name seems like maybe it wasn't meant to be Python. This is a pragmatic fix for issue 82_.
  • The -m switch on coverage report, which includes missing line numbers in the summary report, can now be specified as show_missing in the config file. Closes issue 173_.
  • When running a module with coverage run -m &lt;modulename&gt;, certain details of the execution environment weren't the same as for python -m &lt;modulename&gt;. This had the unfortunate side-effect of making coverage run -m unittest discover not work if you had tests in a directory named "test". This fixes issue 155 and issue 142.
  • Now the exit status of your product code is properly used as the process status when running python -m coverage run .... Thanks, JT Olds.
  • When installing into pypy, we no longer attempt (and fail) to compile the C tracer function, closing issue 166_.

.. _issue 142: https://bitbucket.org/ned/coveragepy/issue/142/executing-python-file-syspath-is-replaced .. _issue 155: https://bitbucket.org/ned/coveragepy/issue/155/cant-use-coverage-run-m-unittest-discover .. _issue 157: https://bitbucket.org/ned/coveragepy/issue/157/chokes-on-source-files-with-non-utf-8 .. _issue 166: https://bitbucket.org/ned/coveragepy/issue/166/dont-try-to-compile-c-extension-on-pypy .. _issue 168: https://bitbucket.org/ned/coveragepy/issue/168/dont-be-alarmed-by-emacs-droppings .. _issue 173: https://bitbucket.org/ned/coveragepy/issue/173/theres-no-way-to-specify-show-missing-in

3.5.1


  • The [paths] feature unfortunately didn't work in real world situations where you wanted to, you know, report on the combined data. Now all paths stored in the combined file are canonicalized properly.

    3.5.1b1


  • When combining data files from parallel runs, you can now instruct coverage.py about which directories are equivalent on different machines. A [paths] section in the configuration file lists paths that are to be considered equivalent. Finishes issue 17_.
  • for-else constructs are understood better, and don't cause erroneous partial branch warnings. Fixes issue 122_.
  • Branch coverage for with statements is improved, fixing issue 128_.
  • The number of partial branches reported on the HTML summary page was different than the number reported on the individual file pages. This is now fixed.
  • An explicit include directive to measure files in the Python installation wouldn't work because of the standard library exclusion. Now the include directive takes precedence, and the files will be measured. Fixes issue 138_.
  • The HTML report now handles Unicode characters in Python source files properly. This fixes issue 124 and issue 144. Thanks, Devin Jeanpierre.
  • In order to help the core developers measure the test coverage of the standard library, Brandon Rhodes devised an aggressive hack to trick Python into running some coverage.py code before anything else in the process. See the coverage/fullcoverage directory if you are interested.

.. _issue 17: http://bitbucket.org/ned/coveragepy/issue/17/support-combining-coverage-data-from .. _issue 122: http://bitbucket.org/ned/coveragepy/issue/122/for-else-always-reports-missing-branch .. _issue 124: http://bitbucket.org/ned/coveragepy/issue/124/no-arbitrary-unicode-in-html-reports-in .. _issue 128: http://bitbucket.org/ned/coveragepy/issue/128/branch-coverage-of-with-statement-in-27 .. _issue 138: http://bitbucket.org/ned/coveragepy/issue/138/include-should-take-precedence-over-is .. _issue 144: http://bitbucket.org/ned/coveragepy/issue/144/failure-generating-html-output-for

3.5


  • The HTML report hotkeys now behave slightly differently when the current chunk isn't visible at all: a chunk on the screen will be selected, instead of the old behavior of jumping to the literal next chunk. The hotkeys now work in Google Chrome. Thanks, Guido van Rossum.

    3.5b1


  • The HTML report now has hotkeys. Try n, s, m, x, b, p, and c on the overview page to change the column sorting. On a file page, r, m, x, and p toggle the run, missing, excluded, and partial line markings. You can navigate the highlighted sections of code by using the j and k keys for next and previous. The 1 (one) key jumps to the first highlighted section in the file, and 0 (zero) scrolls to the top of the file.
  • The --omit and --include switches now interpret their values more usefully. If the value starts with a wildcard character, it is used as-is. If it does not, it is interpreted relative to the current directory. Closes issue 121_.
  • Partial branch warnings can now be pragma'd away. The configuration option partial_branches is a list of regular expressions. Lines matching any of those expressions will never be marked as a partial branch. In addition, there's a built-in list of regular expressions marking statements which should never be marked as partial. This list includes while True:, while 1:, if 1:, and if 0:.
  • The coverage() constructor accepts single strings for the omit= and include= arguments, adapting to a common error in programmatic use.
  • Modules can now be run directly using coverage run -m modulename, to mirror Python's -m flag. Closes issue 95_, thanks, Brandon Rhodes.
  • coverage run didn't emulate Python accurately in one small detail: the current directory inserted into sys.path was relative rather than absolute. This is now fixed.
  • HTML reporting is now incremental: a record is kept of the data that produced the HTML reports, and only files whose data has changed will be generated. This should make most HTML reporting faster.
  • Pathological code execution could disable the trace function behind our backs, leading to incorrect code measurement. Now if this happens, coverage.py will issue a warning, at least alerting you to the problem. Closes issue 93_. Thanks to Marius Gedminas for the idea.
  • The C-based trace function now behaves properly when saved and restored with sys.gettrace() and sys.settrace(). This fixes issue 125 and issue 123. Thanks, Devin Jeanpierre.
  • Source files are now opened with Python 3.2's tokenize.open() where possible, to get the best handling of Python source files with encodings. Closes issue 107_, thanks, Brett Cannon.
  • Syntax errors in supposed Python files can now be ignored during reporting with the -i switch just like other source errors. Closes issue 115_.
  • Installation from source now succeeds on machines without a C compiler, closing issue 80_.
  • Coverage.py can now be run directly from a working tree by specifying the directory name to python: python coverage_py_working_dir run .... Thanks, Brett Cannon.
  • A little bit of Jython support: coverage run can now measure Jython execution by adapting when $py.class files are traced. Thanks, Adi Roiban. Jython still doesn't provide the Python libraries needed to make coverage reporting work, unfortunately.
  • Internally, files are now closed explicitly, fixing issue 104_. Thanks, Brett Cannon.

.. _issue 80: https://bitbucket.org/ned/coveragepy/issue/80/is-there-a-duck-typing-way-to-know-we-cant .. _issue 93: http://bitbucket.org/ned/coveragepy/issue/93/copying-a-mock-object-breaks-coverage .. _issue 95: https://bitbucket.org/ned/coveragepy/issue/95/run-subcommand-should-take-a-module-name .. _issue 104: https://bitbucket.org/ned/coveragepy/issue/104/explicitly-close-files .. _issue 107: https://bitbucket.org/ned/coveragepy/issue/107/codeparser-not-opening-source-files-with .. _issue 115: https://bitbucket.org/ned/coveragepy/issue/115/fail-gracefully-when-reporting-on-file .. _issue 121: https://bitbucket.org/ned/coveragepy/issue/121/filename-patterns-are-applied-stupidly .. _issue 123: https://bitbucket.org/ned/coveragepy/issue/123/pyeval_settrace-used-in-way-that-breaks .. _issue 125: https://bitbucket.org/ned/coveragepy/issue/125/coverage-removes-decoratortoolss-tracing

3.4


  • The XML report is now sorted by package name, fixing issue 88_.
  • Programs that exited with sys.exit() with no argument weren't handled properly, producing a coverage.py stack trace. That is now fixed.

.. _issue 88: http://bitbucket.org/ned/coveragepy/issue/88/xml-report-lists-packages-in-random-order

3.4b2


  • Completely unexecuted files can now be included in coverage results, reported as 0% covered. This only happens if the --source option is specified, since coverage.py needs guidance about where to look for source files.
  • The XML report output now properly includes a percentage for branch coverage, fixing issue 65 and issue 81.
  • Coverage percentages are now displayed uniformly across reporting methods. Previously, different reports could round percentages differently. Also, percentages are only reported as 0% or 100% if they are truly 0 or 100, and are rounded otherwise. Fixes issue 41 and issue 70.
  • The precision of reported coverage percentages can be set with the [report] precision config file setting. Completes issue 16_.
  • Threads derived from threading.Thread with an overridden run method would report no coverage for the run method. This is now fixed, closing issue 85_.

.. _issue 16: http://bitbucket.org/ned/coveragepy/issue/16/allow-configuration-of-accuracy-of-percentage-totals .. _issue 41: http://bitbucket.org/ned/coveragepy/issue/41/report-says-100-when-it-isnt-quite-there .. _issue 65: http://bitbucket.org/ned/coveragepy/issue/65/branch-option-not-reported-in-cobertura .. _issue 70: http://bitbucket.org/ned/coveragepy/issue/70/text-report-and-html-report-disagree-on-coverage .. _issue 81: http://bitbucket.org/ned/coveragepy/issue/81/xml-report-does-not-have-condition-coverage-attribute-for-lines-with-a .. _issue 85: http://bitbucket.org/ned/coveragepy/issue/85/threadrun-isnt-measured

3.4b1


  • BACKWARD INCOMPATIBILITY: the --omit and --include switches now take file patterns rather than file prefixes, closing issue 34 and issue 36.
  • BACKWARD INCOMPATIBILITY: the omit_prefixes argument is gone throughout coverage.py, replaced with omit, a list of file name patterns suitable for fnmatch. A parallel argument include controls what files are included.
  • The run command now has a --source switch, a list of directories or module names. If provided, coverage.py will only measure execution in those source files.
  • Various warnings are printed to stderr for problems encountered during data measurement: if a --source module has no Python source to measure, or is never encountered at all, or if no data is collected.
  • The reporting commands (report, annotate, html, and xml) now have an --include switch to restrict reporting to modules matching those file patterns, similar to the existing --omit switch. Thanks, Zooko.
  • The run command now supports --include and --omit to control what modules it measures. This can speed execution and reduce the amount of data during reporting. Thanks Zooko.
  • Since coverage.py 3.1, using the Python trace function has been slower than it needs to be. A cache of tracing decisions was broken, but has now been fixed.
  • Python 2.7 and 3.2 have introduced new opcodes that are now supported.
  • Python files with no statements, for example, empty __init__.py files, are now reported as having zero statements instead of one. Fixes issue 1_.
  • Reports now have a column of missed line counts rather than executed line counts, since developers should focus on reducing the missed lines to zero, rather than increasing the executed lines to varying targets. Once suggested, this seemed blindingly obvious.
  • Line numbers in HTML source pages are clickable, linking directly to that line, which is highlighted on arrival. Added a link back to the index page at the bottom of each HTML page.
  • Programs that call os.fork will properly collect data from both the child and parent processes. Use coverage run -p to get two data files that can be combined with coverage combine. Fixes issue 56_.
  • Coverage.py is now runnable as a module: python -m coverage. Thanks, Brett Cannon.
  • When measuring code running in a virtualenv, most of the system library was being measured when it shouldn't have been. This is now fixed.
  • Doctest text files are no longer recorded in the coverage data, since they can't be reported anyway. Fixes issue 52 and issue 61.
  • Jinja HTML templates compile into Python code using the HTML file name, which confused coverage.py. Now these files are no longer traced, fixing issue 82_.
  • Source files can have more than one dot in them (foo.test.py), and will be treated properly while reporting. Fixes issue 46_.
  • Source files with DOS line endings are now properly tokenized for syntax coloring on non-DOS machines. Fixes issue 53_.
  • Unusual code structure that confused exits from methods with exits from classes is now properly analyzed. See issue 62_.
  • Asking for an HTML report with no files now shows a nice error message rather than a cryptic failure ('int' object is unsubscriptable). Fixes issue 59_.

.. _issue 1: http://bitbucket.org/ned/coveragepy/issue/1/empty-__init__py-files-are-reported-as-1-executable .. _issue 34: http://bitbucket.org/ned/coveragepy/issue/34/enhanced-omit-globbing-handling .. _issue 36: http://bitbucket.org/ned/coveragepy/issue/36/provide-regex-style-omit .. _issue 46: http://bitbucket.org/ned/coveragepy/issue/46 .. _issue 53: http://bitbucket.org/ned/coveragepy/issue/53 .. _issue 52: http://bitbucket.org/ned/coveragepy/issue/52/doctesttestfile-confuses-source-detection .. _issue 56: http://bitbucket.org/ned/coveragepy/issue/56 .. _issue 61: http://bitbucket.org/ned/coveragepy/issue/61/annotate-i-doesnt-work .. _issue 62: http://bitbucket.org/ned/coveragepy/issue/62 .. _issue 59: http://bitbucket.org/ned/coveragepy/issue/59/html-report-fails-with-int-object-is .. _issue 82: http://bitbucket.org/ned/coveragepy/issue/82/tokenerror-when-generating-html-report

3.3.1


  • Using parallel=True in .coveragerc file prevented reporting, but now does not, fixing issue 49_.
  • When running your code with "coverage run", if you call sys.exit(), coverage.py will exit with that status code, fixing issue 50_.

.. _issue 49: http://bitbucket.org/ned/coveragepy/issue/49 .. _issue 50: http://bitbucket.org/ned/coveragepy/issue/50

3.3


  • Settings are now read from a .coveragerc file. A specific file can be specified on the command line with --rcfile=FILE. The name of the file can be programmatically set with the config_file argument to the coverage() constructor, or reading a config file can be disabled with config_file=False.
  • Fixed a problem with nested loops having their branch possibilities mischaracterized: issue 39_.
  • Added coverage.process_start to enable coverage measurement when Python starts.
  • Parallel data file names now have a random number appended to them in addition to the machine name and process id.
  • Parallel data files combined with "coverage combine" are deleted after they're combined, to clean up unneeded files. Fixes issue 40_.
  • Exceptions thrown from product code run with "coverage run" are now displayed without internal coverage.py frames, so the output is the same as when the code is run without coverage.py.
  • The data_suffix argument to the coverage constructor is now appended with an added dot rather than simply appended, so that .coveragerc files will not be confused for data files.
  • Python source files that don't end with a newline can now be executed, fixing issue 47_.
  • Added an AUTHORS.txt file.

.. _issue 39: http://bitbucket.org/ned/coveragepy/issue/39 .. _issue 40: http://bitbucket.org/ned/coveragepy/issue/40 .. _issue 47: http://bitbucket.org/ned/coveragepy/issue/47

3.2


  • Added a --version option on the command line.

    3.2b4


  • Branch coverage improvements:
    • The XML report now includes branch information.
  • Click-to-sort HTML report columns are now persisted in a cookie. Viewing a report will sort it first the way you last had a coverage report sorted. Thanks, Chris Adams_.
  • On Python 3.x, setuptools has been replaced by Distribute_.

.. _Distribute: http://packages.python.org/distribute/

3.2b3


  • Fixed a memory leak in the C tracer that was introduced in 3.2b1.
  • Branch coverage improvements:
    • Branches to excluded code are ignored.
  • The table of contents in the HTML report is now sortable: click the headers on any column. Thanks, Chris Adams_.

.. _Chris Adams: http://improbable.org/chris/

3.2b2


  • Branch coverage improvements:
    • Classes are no longer incorrectly marked as branches: issue 32_.
    • "except" clauses with types are no longer incorrectly marked as branches: issue 35_.
  • Fixed some problems syntax coloring sources with line continuations and source with tabs: issue 30 and issue 31.
  • The --omit option now works much better than before, fixing issue 14 and issue 33. Thanks, Danek Duvall.

.. _issue 14: http://bitbucket.org/ned/coveragepy/issue/14 .. _issue 30: http://bitbucket.org/ned/coveragepy/issue/30 .. _issue 31: http://bitbucket.org/ned/coveragepy/issue/31 .. _issue 32: http://bitbucket.org/ned/coveragepy/issue/32 .. _issue 33: http://bitbucket.org/ned/coveragepy/issue/33 .. _issue 35: http://bitbucket.org/ned/coveragepy/issue/35

3.2b1


  • Branch coverage!
  • XML reporting has file paths that let Cobertura find the source code.
  • The tracer code has changed, it's a few percent faster.
  • Some exceptions reported by the command line interface have been cleaned up so that tracebacks inside coverage.py aren't shown. Fixes issue 23_.

.. _issue 23: http://bitbucket.org/ned/coveragepy/issue/23

3.1


  • Source code can now be read from eggs. Thanks, Ross Lawley. Fixes issue 25_.

.. _issue 25: http://bitbucket.org/ned/coveragepy/issue/25

3.1b1


  • Python 3.1 is now supported.
  • Coverage.py has a new command line syntax with sub-commands. This expands the possibilities for adding features and options in the future. The old syntax is still supported. Try "coverage help" to see the new commands. Thanks to Ben Finney for early help.
  • Added an experimental "coverage xml" command for producing coverage reports in a Cobertura-compatible XML format. Thanks, Bill Hart.
  • Added the --timid option to enable a simpler slower trace function that works for DecoratorTools projects, including TurboGears. Fixed issue 12 and issue 13.
  • HTML reports show modules from other directories. Fixed issue 11_.
  • HTML reports now display syntax-colored Python source.
  • Programs that change directory will still write .coverage files in the directory where execution started. Fixed issue 24_.
  • Added a "coverage debug" command for getting diagnostic information about the coverage.py installation.

.. _issue 11: http://bitbucket.org/ned/coveragepy/issue/11 .. _issue 12: http://bitbucket.org/ned/coveragepy/issue/12 .. _issue 13: http://bitbucket.org/ned/coveragepy/issue/13 .. _issue 24: http://bitbucket.org/ned/coveragepy/issue/24

3.0.1


  • Removed the recursion limit in the tracer function. Previously, code that ran more than 500 frames deep would crash. Fixed issue 9_.
  • Fixed a bizarre problem involving pyexpat, whereby lines following XML parser invocations could be overlooked. Fixed issue 10_.
  • On Python 2.3, coverage.py could mis-measure code with exceptions being raised. This is now fixed.
  • The coverage.py code itself will now not be measured by coverage.py, and no coverage.py modules will be mentioned in the nose --with-cover plug-in. Fixed issue 8_.
  • When running source files, coverage.py now opens them in universal newline mode just like Python does. This lets it run Windows files on Mac, for example.

.. _issue 9: http://bitbucket.org/ned/coveragepy/issue/9 .. _issue 10: http://bitbucket.org/ned/coveragepy/issue/10 .. _issue 8: http://bitbucket.org/ned/coveragepy/issue/8

3.0


  • Fixed the way the Python library was ignored. Too much code was being excluded the old way.
  • Tabs are now properly converted in HTML reports. Previously indentation was lost. Fixed issue 6_.
  • Nested modules now get a proper flat_rootname. Thanks, Christian Heimes.

.. _issue 6: http://bitbucket.org/ned/coveragepy/issue/6

3.0b3


  • Added parameters to coverage.init for options that had been set on the coverage object itself.
  • Added clear_exclude() and get_exclude_list() methods for programmatic manipulation of the exclude regexes.
  • Added coverage.load() to read previously-saved data from the data file.
  • Improved the finding of code files. For example, .pyc files that have been installed after compiling are now located correctly. Thanks, Detlev Offenbach.
  • When using the object API (that is, constructing a coverage() object), data is no longer saved automatically on process exit. You can re-enable it with the auto_data=True parameter on the coverage() constructor. The module-level interface still uses automatic saving.

    3.0b1


Major overhaul.

  • Coverage.py is now a package rather than a module. Functionality has been split into classes.
  • The trace function is implemented in C for speed. Coverage.py runs are now much faster. Thanks to David Christian for productive micro-sprints and other encouragement.
  • Executable lines are identified by reading the line number tables in the compiled code, removing a great deal of complicated analysis code.
  • Precisely which lines are considered executable has changed in some cases. Therefore, your coverage stats may also change slightly.
  • The singleton coverage object is only created if the module-level functions are used. This maintains the old interface while allowing better programmatic use of Coverage.py.
  • The minimum supported Python version is 2.3.

    3.0b


HTML reporting, and continued refactoring.

  • HTML reports and annotation of source files: use the new -b (browser) switch. Thanks to George Song for code, inspiration and guidance.
  • Code in the Python standard library is not measured by default. If you need to measure standard library code, use the -L command-line switch during execution, or the cover_pylib=True argument to the coverage() constructor.
  • Source annotation into a directory (-a -d) behaves differently. The annotated files are named with their hierarchy flattened so that same-named files from different directories no longer collide. Also, only files in the current tree are included.
  • coverage.annotate_file is no longer available.
  • Programs executed with -x now behave more as they should, for example, file has the correct value.
  • .coverage data files have a new pickle-based format designed for better extensibility.
  • Removed the undocumented cache_file argument to coverage.usecache().

    2.85


  • Add support for finding source files in eggs. Don't check for morf's being instances of ModuleType, instead use duck typing so that pseudo-modules can participate. Thanks, Imri Goldberg.
  • Use os.realpath as part of the fixing of file names so that symlinks won't confuse things. Thanks, Patrick Mezard.

    2.80


  • Open files in rU mode to avoid line ending craziness. Thanks, Edward Loper.

    2.78


  • Don't try to predict whether a file is Python source based on the extension. Extension-less files are often Pythons scripts. Instead, simply parse the file and catch the syntax errors. Hat tip to Ben Finney.

    2.77


  • Better packaging.

    2.76


  • Now Python 2.5 is really fully supported: the body of the new with statement is counted as executable.

    2.75


  • Python 2.5 now fully supported. The method of dealing with multi-line statements is now less sensitive to the exact line that Python reports during execution. Pass statements are handled specially so that their disappearance during execution won't throw off the measurement.

    2.7


  • "pragma: nocover" is excluded by default.
  • Properly ignore docstrings and other constant expressions that appear in the middle of a function, a problem reported by Tim Leslie.
  • coverage.erase() shouldn't clobber the exclude regex. Change how parallel mode is invoked, and fix erase() so that it erases the cache when called programmatically.
  • In reports, ignore code executed from strings, since we can't do anything useful with it anyway.
  • Better file handling on Linux, thanks Guillaume Chazarain.
  • Better shell support on Windows, thanks Noel O'Boyle.
  • Python 2.2 support maintained, thanks Catherine Proulx.
  • Minor changes to avoid lint warnings.

    2.6


  • Applied Joseph Tate's patch for function decorators.
  • Applied Sigve Tjora and Mark van der Wal's fixes for argument handling.
  • Applied Geoff Bache's parallel mode patch.
  • Refactorings to improve testability. Fixes to command-line logic for parallel mode and collect.

    2.5


  • Call threading.settrace so that all threads are measured. Thanks Martin Fuzzey.
  • Add a file argument to report so that reports can be captured to a different destination.
  • Coverage.py can now measure itself.
  • Adapted Greg Rogers' patch for using relative file names, and sorting and omitting files to report on.

    2.2


  • Allow for keyword arguments in the module global functions. Thanks, Allen.

    2.1


  • Return 'analysis' to its original behavior and add 'analysis2'. Add a global for 'annotate', and factor it, adding 'annotate_file'.

    2.0


Significant code changes.

  • Finding executable statements has been rewritten so that docstrings and other quirks of Python execution aren't mistakenly identified as missing lines.
  • Lines can be excluded from consideration, even entire suites of lines.
  • The file system cache of covered lines can be disabled programmatically.
  • Modernized the code.

    Earlier History

2001-12-04 GDR Created.

2001-12-06 GDR Added command-line interface and source code annotation.

2001-12-09 GDR Moved design and interface to separate documents.

2001-12-10 GDR Open cache file as binary on Windows. Allow simultaneous -e and -x, or -a and -r.

2001-12-12 GDR Added command-line help. Cache analysis so that it only needs to be done once when you specify -a and -r.

1.5.2

and 2.1.1.

2002-01-03 GDR Module-level functions work correctly.

2002-01-07 GDR Update sys.path when running a file with the -x option, so that it matches the value the program would get if it were run on its own.

pytest -> 3.0.3

3.0.3

  • The ids argument to parametrize again accepts unicode strings in Python 2 (1905). Thanks philpep for the report and nicoddemus_ for the PR.
  • Assertions are now being rewritten for plugins in development mode (pip install -e) (1934). Thanks nicoddemus for the PR.
  • Fix pkgresources import error in Jython projects (1853). Thanks raquel-ucl for the PR.
  • Got rid of AttributeError: &#39;Module&#39; object has no attribute &#39;_obj&#39; exception in Python 3 (1944). Thanks axil for the PR.
  • Explain a bad scope value passed to fixture declarations or a MetaFunc.parametrize() call. Thanks tgoodlet_ for the PR.
  • This version includes pluggy-0.4.0, which correctly handles VersionConflict errors in plugins (704). Thanks nicoddemus for the PR.

.. _philpep: https://github.com/philpep .. _raquel-ucl: https://github.com/raquel-ucl .. _axil: https://github.com/axil .. _tgoodlet: https://github.com/tgoodlet

.. _1905: https://github.com/pytest-dev/pytest/issues/1905 .. _1934: https://github.com/pytest-dev/pytest/issues/1934 .. _1944: https://github.com/pytest-dev/pytest/issues/1944 .. _704: https://github.com/pytest-dev/pytest/issues/704

3.0.2

  • Improve error message when passing non-string ids to pytest.mark.parametrize (1857). Thanks okken for the report and nicoddemus_ for the PR.
  • Add buffer attribute to stdin stub class pytest.capture.DontReadFromInput Thanks joguSD_ for the PR.
  • Fix UnicodeEncodeError when string comparison with unicode has failed. (1864) Thanks AiOO for the PR.
  • pytest_plugins is now handled correctly if defined as a string (as opposed as a sequence of strings) when modules are considered for assertion rewriting. Due to this bug, much more modules were being rewritten than necessary if a test suite uses pytest_plugins to load internal plugins (1888). Thanks jaraco for the report and nicoddemus for the PR (1891).
  • Do not call tearDown and cleanups when running tests from unittest.TestCase subclasses with --pdb enabled. This allows proper post mortem debugging for all applications which have significant logic in their tearDown machinery (1890). Thanks mbyt for the PR.
  • Fix use of deprecated getfuncargvalue method in the internal doctest plugin. Thanks ViviCoder for the report (1898).

.. _joguSD: https://github.com/joguSD .. _AiOO: https://github.com/AiOO .. _mbyt: https://github.com/mbyt .. _ViviCoder: https://github.com/ViviCoder

.. _1857: https://github.com/pytest-dev/pytest/issues/1857 .. _1864: https://github.com/pytest-dev/pytest/issues/1864 .. _1888: https://github.com/pytest-dev/pytest/issues/1888 .. _1891: https://github.com/pytest-dev/pytest/pull/1891 .. _1890: https://github.com/pytest-dev/pytest/issues/1890 .. _1898: https://github.com/pytest-dev/pytest/issues/1898

3.0.1

  • Fix regression when importorskip is used at module level (1822). Thanks jaraco and The-Compiler for the report and nicoddemus for the PR.
  • Fix parametrization scope when session fixtures are used in conjunction with normal parameters in the same call (1832). Thanks The-Compiler for the report, Kingdread and nicoddemus for the PR.
  • Fix internal error when parametrizing tests or fixtures using an empty ids argument (1849). Thanks OPpuolitaival for the report and nicoddemus_ for the PR.
  • Fix loader error when running pytest embedded in a zipfile. Thanks mbachry_ for the PR.

.. _Kingdread: https://github.com/Kingdread .. _mbachry: https://github.com/mbachry .. _OPpuolitaival: https://github.com/OPpuolitaival

.. _1822: https://github.com/pytest-dev/pytest/issues/1822 .. _1832: https://github.com/pytest-dev/pytest/issues/1832 .. _1849: https://github.com/pytest-dev/pytest/issues/1849

3.0.0

Incompatible changes

A number of incompatible changes were made in this release, with the intent of removing features deprecated for a long time or change existing behaviors in order to make them less surprising/more useful.

  • Reinterpretation mode has now been removed. Only plain and rewrite mode are available, consequently the --assert=reinterp option is no longer available. This also means files imported from plugins or conftest.py will not benefit from improved assertions by default, you should use pytest.register_assert_rewrite() to explicitly turn on assertion rewriting for those files. Thanks flub_ for the PR.
  • The following deprecated commandline options were removed:

    • --genscript: no longer supported;
    • --no-assert: use --assert=plain instead;
    • --nomagic: use --assert=plain instead;
    • --report: use -r instead;

    Thanks to RedBeardCode for the PR (1664).

  • ImportErrors in plugins now are a fatal error instead of issuing a pytest warning (1479). Thanks to The-Compiler for the PR.
  • Removed support code for Python 3 versions < 3.3 (1627_).
  • Removed all py.test-X* entry points. The versioned, suffixed entry points were never documented and a leftover from a pre-virtualenv era. These entry points also created broken entry points in wheels, so removing them also removes a source of confusion for users (1632). Thanks obestwalter for the PR.
  • pytest.skip() now raises an error when used to decorate a test function, as opposed to its original intent (to imperatively skip a test inside a test function). Previously this usage would cause the entire module to be skipped (607). Thanks omarkohl for the complete PR (1519_).
  • Exit tests if a collection error occurs. A poll indicated most users will hit CTRL-C anyway as soon as they see collection errors, so pytest might as well make that the default behavior (1421). A --continue-on-collection-errors option has been added to restore the previous behaviour. Thanks olegpidsadnyi and omarkohl for the complete PR (1628).
  • Renamed the pytest pdb module (plugin) into debugging to avoid clashes with the builtin pdb module.
  • Raise a helpful failure message when requesting a parametrized fixture at runtime, e.g. with request.getfixturevalue. Previously these parameters were simply never defined, so a fixture decorated like pytest.fixture(params=[0, 1, 2]) only ran once (460). Thanks to nikratio for the bug report, RedBeardCode and tomviner for the PR.
  • _pytest.monkeypatch.monkeypatch class has been renamed to _pytest.monkeypatch.MonkeyPatch so it doesn't conflict with the monkeypatch fixture.
  • --exitfirst / -x can now be overridden by a following --maxfail=N and is just a synonym for --maxfail=1.

New Features

  • Support nose-style __test__ attribute on methods of classes, including unittest-style Classes. If set to False, the test will not be collected.
  • New doctest_namespace fixture for injecting names into the namespace in which doctests run. Thanks milliams for the complete PR (1428).
  • New --doctest-report option available to change the output format of diffs when running (failing) doctests (implements 1749). Thanks hartym for the PR.
  • New name argument to pytest.fixture decorator which allows a custom name for a fixture (to solve the funcarg-shadowing-fixture problem). Thanks novas0x2a for the complete PR (1444).
  • New approx() function for easily comparing floating-point numbers in tests. Thanks kalekundert for the complete PR (1441).
  • Ability to add global properties in the final xunit output file by accessing the internal junitxml plugin (experimental). Thanks tareqalayan for the complete PR 1454).
  • New ExceptionInfo.match() method to match a regular expression on the string representation of an exception (372). Thanks omarkohl for the complete PR (1502_).
  • __tracebackhide__ can now also be set to a callable which then can decide whether to filter the traceback based on the ExceptionInfo object passed to it. Thanks The-Compiler for the complete PR (1526).
  • New pytest_make_parametrize_id(config, val) hook which can be used by plugins to provide friendly strings for custom types. Thanks palaviv_ for the PR.
  • capsys and capfd now have a disabled() context-manager method, which can be used to temporarily disable capture within a test. Thanks nicoddemus_ for the PR.
  • New cli flag --fixtures-per-test: shows which fixtures are being used for each selected test item. Features doc strings of fixtures by default. Can also show where fixtures are defined if combined with -v. Thanks hackebrot_ for the PR.
  • Introduce pytest command as recommended entry point. Note that py.test still works and is not scheduled for removal. Closes proposal 1629. Thanks obestwalter and davehunt for the complete PR (1633).
  • New cli flags:

    • --setup-plan: performs normal collection and reports the potential setup and teardown and does not execute any fixtures and tests;
    • --setup-only: performs normal collection, executes setup and teardown of fixtures and reports them;
    • --setup-show: performs normal test execution and additionally shows setup and teardown of fixtures;
    • --keep-duplicates: py.test now ignores duplicated paths given in the command line. To retain the previous behavior where the same test could be run multiple times by specifying it in the command-line multiple times, pass the --keep-duplicates argument (1609_);

    Thanks d6e, kvas-it, sallner, ioggstream and omarkohl_ for the PRs.

  • New CLI flag --override-ini/-o: overrides values from the ini file. For example: &quot;-o xfail_strict=True&quot;'. Thanks blueyed and fengxx for the PR.
  • New hooks:

    • pytest_fixture_setup(fixturedef, request): executes fixture setup;
    • pytest_fixture_post_finalizer(fixturedef): called after the fixture's finalizer and has access to the fixture's result cache.

    Thanks d6e, sallner.

  • Issue warnings for asserts whose test is a tuple literal. Such asserts will never fail because tuples are always truthy and are usually a mistake (see 1562). Thanks kvas-it, for the PR.
  • Allow passing a custom debugger class (e.g. --pdbcls=IPython.core.debugger:Pdb). Thanks to anntzer_ for the PR.

Changes

  • Plugins now benefit from assertion rewriting. Thanks sober7, nicoddemus and flub_ for the PR.
  • Change report.outcome for xpassed tests to &quot;passed&quot; in non-strict mode and &quot;failed&quot; in strict mode. Thanks to hackebrot for the PR (1795) and gprasad84 for report (1546).
  • Tests marked with xfail(strict=False) (the default) now appear in JUnitXML reports as passing tests instead of skipped. Thanks to hackebrot for the PR (1795).
  • Highlight path of the file location in the error report to make it easier to copy/paste. Thanks suzaku for the PR (1778).
  • Fixtures marked with pytest.fixture can now use yield statements exactly like those marked with the pytest.yield_fixture decorator. This change renders pytest.yield_fixture deprecated and makes pytest.fixture with yield statements the preferred way to write teardown code (1461). Thanks csaftoiu for bringing this to attention and nicoddemus_ for the PR.
  • Explicitly passed parametrize ids do not get escaped to ascii (1351). Thanks ceridwen for the PR.
  • Fixtures are now sorted in the error message displayed when an unknown fixture is declared in a test function. Thanks nicoddemus_ for the PR.
  • pytest_terminal_summary hook now receives the exitstatus of the test session as argument. Thanks blueyed for the PR (1809).
  • Parametrize ids can accept None as specific test id, in which case the automatically generated id for that argument will be used. Thanks palaviv for the complete PR (1468).
  • The parameter to xunit-style setup/teardown methods (setup_method, setup_module, etc.) is now optional and may be omitted. Thanks okken for bringing this to attention and nicoddemus for the PR.
  • Improved automatic id generation selection in case of duplicate ids in parametrize. Thanks palaviv for the complete PR (1474).
  • Now pytest warnings summary is shown up by default. Added a new flag --disable-pytest-warnings to explicitly disable the warnings summary (1668_).
  • Make ImportError during collection more explicit by reminding the user to check the name of the test module/package(s) (1426). Thanks omarkohl for the complete PR (1520_).
  • Add build/ and dist/ to the default --norecursedirs list. Thanks mikofski for the report and tomviner for the PR (1544_).
  • pytest.raises in the context manager form accepts a custom message to raise when no exception occurred. Thanks palaviv for the complete PR (1616).
  • conftest.py files now benefit from assertion rewriting; previously it was only available for test modules. Thanks flub, sober7 and nicoddemus for the PR (1619).
  • Text documents without any doctests no longer appear as "skipped". Thanks graingert for reporting and providing a full PR (1580).
  • Ensure that a module within a namespace package can be found when it is specified on the command line together with the --pyargs option. Thanks to taschini for the PR (1597).
  • Always include full assertion explanation during assertion rewriting. The previous behaviour was hiding sub-expressions that happened to be False, assuming this was redundant information. Thanks bagerard for reporting (1503). Thanks to davehunt and tomviner for the PR.
  • OptionGroup.addoption() now checks if option names were already added before, to make it easier to track down issues like 1618_. Before, you only got exceptions later from argparse library, giving no clue about the actual reason for double-added options.
  • yield-based tests are considered deprecated and will be removed in pytest-4.0. Thanks nicoddemus_ for the PR.
  • [pytest] sections in setup.cfg files should now be named [tool:pytest] to avoid conflicts with other distutils commands (see 567). [pytest] sections in pytest.ini or tox.ini files are supported and unchanged. Thanks nicoddemus for the PR.
  • Using pytest_funcarg__ prefix to declare fixtures is considered deprecated and will be removed in pytest-4.0 (1684). Thanks nicoddemus for the PR.
  • Passing a command-line string to pytest.main() is considered deprecated and scheduled for removal in pytest-4.0. It is recommended to pass a list of arguments instead (1723_).
  • Rename getfuncargvalue to getfixturevalue. getfuncargvalue is still present but is now considered deprecated. Thanks to RedBeardCode and tomviner for the PR (1626_).
  • optparse type usage now triggers DeprecationWarnings (1740_).
  • optparse backward compatibility supports float/complex types (457_).
  • Refined logic for determining the rootdir, considering only valid paths which fixes a number of issues: 1594, 1435 and 1471. Updated the documentation according to current behavior. Thanks to blueyed, davehunt and matthiasha for the PR.
  • Always include full assertion explanation. The previous behaviour was hiding sub-expressions that happened to be False, assuming this was redundant information. Thanks bagerard for reporting (1503). Thanks to davehunt and tomviner for PR.
  • Better message in case of not using parametrized variable (see 1539). Thanks to tramwaj29 for the PR.
  • Updated docstrings with a more uniform style.
  • Add stderr write for pytest.exit(msg) during startup. Previously the message was never shown. Thanks BeyondEvil for reporting 1210. Thanks to JonathonSonesen and tomviner for the PR.
  • No longer display the incorrect test deselection reason (1372). Thanks ronnypfannschmidt for the PR.
  • The --resultlog command line option has been deprecated: it is little used and there are more modern and better alternatives (see 830). Thanks nicoddemus for the PR.
  • Improve error message with fixture lookup errors: add an 'E' to the first line and '>' to the rest. Fixes 717. Thanks blueyed for reporting and a PR, eolo999 for the initial PR and tomviner for his guidance during EuroPython2016 sprint.

Bug Fixes

  • Parametrize now correctly handles duplicated test ids.
  • Fix internal error issue when the method argument is missing for teardown_method() (1605_).
  • Fix exception visualization in case the current working directory (CWD) gets deleted during testing (1235). Thanks bukzor for reporting. PR by marscher_.
  • Improve test output for logical expression with brackets (925). Thanks DRMacIver for reporting and RedBeardCode_ for the PR.
  • Create correct diff for strings ending with newlines (1553). Thanks Vogtinator for reporting and RedBeardCode and tomviner for the PR.
  • ConftestImportFailure now shows the traceback making it easier to identify bugs in conftest.py files (1516). Thanks txomon for the PR.
  • Text documents without any doctests no longer appear as "skipped". Thanks graingert for reporting and providing a full PR (1580).
  • Fixed collection of classes with custom __new__ method. Fixes 1579. Thanks to Stranger6667 for the PR.
  • Fixed scope overriding inside metafunc.parametrize (634). Thanks to Stranger6667 for the PR.
  • Fixed the total tests tally in junit xml output (1798). Thanks to cryporchild for the PR.
  • Fixed off-by-one error with lines from request.node.warn. Thanks to blueyed_ for the PR.

.. _1210: https://github.com/pytest-dev/pytest/issues/1210 .. _1235: https://github.com/pytest-dev/pytest/issues/1235 .. _1351: https://github.com/pytest-dev/pytest/issues/1351 .. _1372: https://github.com/pytest-dev/pytest/issues/1372 .. _1421: https://github.com/pytest-dev/pytest/issues/1421 .. _1426: https://github.com/pytest-dev/pytest/issues/1426 .. _1428: https://github.com/pytest-dev/pytest/pull/1428 .. _1435: https://github.com/pytest-dev/pytest/issues/1435 .. _1441: https://github.com/pytest-dev/pytest/pull/1441 .. _1444: https://github.com/pytest-dev/pytest/pull/1444 .. _1454: https://github.com/pytest-dev/pytest/pull/1454 .. _1461: https://github.com/pytest-dev/pytest/pull/1461 .. _1468: https://github.com/pytest-dev/pytest/pull/1468 .. _1471: https://github.com/pytest-dev/pytest/issues/1471 .. _1474: https://github.com/pytest-dev/pytest/pull/1474 .. _1479: https://github.com/pytest-dev/pytest/issues/1479 .. _1502: https://github.com/pytest-dev/pytest/pull/1502 .. _1503: https://github.com/pytest-dev/pytest/issues/1503 .. _1516: https://github.com/pytest-dev/pytest/pull/1516 .. _1519: https://github.com/pytest-dev/pytest/pull/1519 .. _1520: https://github.com/pytest-dev/pytest/pull/1520 .. _1526: https://github.com/pytest-dev/pytest/pull/1526 .. _1539: https://github.com/pytest-dev/pytest/issues/1539 .. _1544: https://github.com/pytest-dev/pytest/issues/1544 .. _1546: https://github.com/pytest-dev/pytest/issues/1546 .. _1553: https://github.com/pytest-dev/pytest/issues/1553 .. _1562: https://github.com/pytest-dev/pytest/issues/1562 .. _1579: https://github.com/pytest-dev/pytest/issues/1579 .. _1580: https://github.com/pytest-dev/pytest/pull/1580 .. _1594: https://github.com/pytest-dev/pytest/issues/1594 .. _1597: https://github.com/pytest-dev/pytest/pull/1597 .. _1605: https://github.com/pytest-dev/pytest/issues/1605 .. _1616: https://github.com/pytest-dev/pytest/pull/1616 .. _1618: https://github.com/pytest-dev/pytest/issues/1618 .. _1619: https://github.com/pytest-dev/pytest/issues/1619 .. _1626: https://github.com/pytest-dev/pytest/pull/1626 .. _1627: https://github.com/pytest-dev/pytest/pull/1627 .. _1628: https://github.com/pytest-dev/pytest/pull/1628 .. _1629: https://github.com/pytest-dev/pytest/issues/1629 .. _1632: https://github.com/pytest-dev/pytest/issues/1632 .. _1633: https://github.com/pytest-dev/pytest/pull/1633 .. _1664: https://github.com/pytest-dev/pytest/pull/1664 .. _1668: https://github.com/pytest-dev/pytest/issues/1668 .. _1684: https://github.com/pytest-dev/pytest/pull/1684 .. _1723: https://github.com/pytest-dev/pytest/pull/1723 .. _1740: https://github.com/pytest-dev/pytest/issues/1740 .. _1749: https://github.com/pytest-dev/pytest/issues/1749 .. _1778: https://github.com/pytest-dev/pytest/pull/1778 .. _1795: https://github.com/pytest-dev/pytest/pull/1795 .. _1798: https://github.com/pytest-dev/pytest/pull/1798 .. _1809: https://github.com/pytest-dev/pytest/pull/1809 .. _372: https://github.com/pytest-dev/pytest/issues/372 .. _457: https://github.com/pytest-dev/pytest/issues/457 .. _460: https://github.com/pytest-dev/pytest/pull/460 .. _567: https://github.com/pytest-dev/pytest/pull/567 .. _607: https://github.com/pytest-dev/pytest/issues/607 .. _634: https://github.com/pytest-dev/pytest/issues/634 .. _717: https://github.com/pytest-dev/pytest/issues/717 .. _830: https://github.com/pytest-dev/pytest/issues/830 .. _925: https://github.com/pytest-dev/pytest/issues/925

.. _anntzer: https://github.com/anntzer .. _bagerard: https://github.com/bagerard .. _BeyondEvil: https://github.com/BeyondEvil .. _blueyed: https://github.com/blueyed .. _ceridwen: https://github.com/ceridwen .. _cryporchild: https://github.com/cryporchild .. _csaftoiu: https://github.com/csaftoiu .. _d6e: https://github.com/d6e .. _davehunt: https://github.com/davehunt .. _DRMacIver: https://github.com/DRMacIver .. _eolo999: https://github.com/eolo999 .. _fengxx: https://github.com/fengxx .. _flub: https://github.com/flub .. _gprasad84: https://github.com/gprasad84 .. _graingert: https://github.com/graingert .. _hartym: https://github.com/hartym .. _JonathonSonesen: https://github.com/JonathonSonesen .. _kalekundert: https://github.com/kalekundert .. _kvas-it: https://github.com/kvas-it .. _marscher: https://github.com/marscher .. _mikofski: https://github.com/mikofski .. _milliams: https://github.com/milliams .. _nikratio: https://github.com/nikratio .. _novas0x2a: https://github.com/novas0x2a .. _obestwalter: https://github.com/obestwalter .. _okken: https://github.com/okken .. _olegpidsadnyi: https://github.com/olegpidsadnyi .. _omarkohl: https://github.com/omarkohl .. _palaviv: https://github.com/palaviv .. _RedBeardCode: https://github.com/RedBeardCode .. _sallner: https://github.com/sallner .. _sober7: https://github.com/sober7 .. _Stranger6667: https://github.com/Stranger6667 .. _suzaku: https://github.com/suzaku .. _tareqalayan: https://github.com/tareqalayan .. _taschini: https://github.com/taschini .. _tramwaj29: https://github.com/tramwaj29 .. _txomon: https://github.com/txomon .. _Vogtinator: https://github.com/Vogtinator .. _matthiasha: https://github.com/matthiasha

2.9.2

Bug Fixes

  • fix 510: skip tests where one parameterize dimension was empty thanks Alex Stapleton for the Report and RonnyPfannschmidt for the PR
  • Fix Xfail does not work with condition keyword argument. Thanks astraw38 for reporting the issue (1496) and tomviner for PR the (1524).
  • Fix win32 path issue when puttinging custom config file with absolute path in pytest.main(&quot;-c your_absolute_path&quot;).
  • Fix maximum recursion depth detection when raised error class is not aware of unicode/encoded bytes. Thanks prusse-martin for the PR (1506).
  • Fix pytest.mark.skip mark when used in strict mode. Thanks pquentin for the PR and RonnyPfannschmidt for showing how to fix the bug.
  • Minor improvements and fixes to the documentation. Thanks omarkohl_ for the PR.
  • Fix --fixtures to show all fixture definitions as opposed to just one per fixture name. Thanks to hackebrot_ for the PR.

.. _510: https://github.com/pytest-dev/pytest/issues/510 .. _1506: https://github.com/pytest-dev/pytest/pull/1506 .. _1496: https://github.com/pytest-dev/pytest/issues/1496 .. _1524: https://github.com/pytest-dev/pytest/pull/1524

.. _prusse-martin: https://github.com/prusse-martin .. _astraw38: https://github.com/astraw38

2.9.1

Bug Fixes

  • Improve error message when a plugin fails to load. Thanks nicoddemus_ for the PR.
  • Fix (1178 &lt;https://github.com/pytest-dev/pytest/issues/1178&gt;): pytest.fail with non-ascii characters raises an internal pytest error. Thanks nicoddemus for the PR.
  • Fix (469): junit parses report.nodeid incorrectly, when params IDs contain ::. Thanks tomviner for the PR (1431_).
  • Fix (578 &lt;https://github.com/pytest-dev/pytest/issues/578&gt;): SyntaxErrors containing non-ascii lines at the point of failure generated an internal py.test error. Thanks asottile for the report and nicoddemus_ for the PR.
  • Fix (1437_): When passing in a bytestring regex pattern to parameterize attempt to decode it as utf-8 ignoring errors.
  • Fix (649_): parametrized test nodes cannot be specified to run on the command line.
  • Fix (138_): better reporting for python 3.3+ chained exceptions

.. _1437: https://github.com/pytest-dev/pytest/issues/1437 .. _469: https://github.com/pytest-dev/pytest/issues/469 .. _1431: https://github.com/pytest-dev/pytest/pull/1431 .. _649: https://github.com/pytest-dev/pytest/issues/649 .. _138: https://github.com/pytest-dev/pytest/issues/138

.. _asottile: https://github.com/asottile

2.9.0

New Features

  • New pytest.mark.skip mark, which unconditionally skips marked tests. Thanks MichaelAquilina for the complete PR (1040).
  • --doctest-glob may now be passed multiple times in the command-line. Thanks jab and nicoddemus for the PR.
  • New -rp and -rP reporting options give the summary and full output of passing tests, respectively. Thanks to codewarrior0_ for the PR.
  • pytest.mark.xfail now has a strict option, which makes XPASS tests to fail the test suite (defaulting to False). There's also a xfail_strict ini option that can be used to configure it project-wise. Thanks rabbbit for the request and nicoddemus for the PR (1355_).
  • Parser.addini now supports options of type bool. Thanks nicoddemus_ for the PR.
  • New ALLOW_BYTES doctest option. This strips b prefixes from byte strings in doctest output (similar to ALLOW_UNICODE). Thanks jaraco for the request and nicoddemus for the PR (1287_).
  • Give a hint on KeyboardInterrupt to use the --fulltrace option to show the errors. Fixes 1366. Thanks to hpk42 for the report and RonnyPfannschmidt_ for the PR.
  • Catch IndexError exceptions when getting exception source location. Fixes a pytest internal error for dynamically generated code (fixtures and tests) where source lines are fake by intention.

Changes

  • Important: py.code &lt;https://pylib.readthedocs.io/en/latest/code.html&gt;_ has been merged into the pytest repository as pytest._code. This decision was made because py.code had very few uses outside pytest and the fact that it was in a different repository made it difficult to fix bugs on its code in a timely manner. The team hopes with this to be able to better refactor out and improve that code. This change shouldn't affect users, but it is useful to let users aware if they encounter any strange behavior.

    Keep in mind that the code for pytest._code is private and experimental, so you definitely should not import it explicitly!

    Please note that the original py.code is still available in pylib &lt;https://pylib.readthedocs.io&gt;_.

  • pytest_enter_pdb now optionally receives the pytest config object. Thanks nicoddemus_ for the PR.
  • Removed code and documentation for Python 2.5 or lower versions, including removal of the obsolete _pytest.assertion.oldinterpret module. Thanks nicoddemus for the PR (1226).
  • Comparisons now always show up in full when CI or BUILD_NUMBER is found in the environment, even when -vv isn't used. Thanks The-Compiler_ for the PR.
  • --lf and --ff now support long names: --last-failed and --failed-first respectively. Thanks MichaelAquilina_ for the PR.
  • Added expected exceptions to pytest.raises fail message.
  • Collection only displays progress ("collecting X items") when in a terminal. This avoids cluttering the output when using --color=yes to obtain colors in CI integrations systems (1397_).

Bug Fixes

  • The -s and -c options should now work under xdist; Config.fromdictargs now represents its input much more faithfully. Thanks to bukzor for the complete PR (680).
  • Fix (1290): support Python 3.5's ```operator in assertion rewriting. ThanksShinkenjoe` for report with test case and tomviner_ for the PR.
  • Fix formatting utf-8 explanation messages (1379). Thanks biern for the PR.
  • Fix traceback style docs to describe all of the available options (auto/long/short/line/native/no), with auto being the default since v2.6. Thanks hackebrot for the PR.
  • Fix (1422_): junit record_xml_property doesn't allow multiple records with same name.

.. _traceback style docs: https://pytest.org/latest/usage.htmlmodifying-python-traceback-printing

.. _1609: https://github.com/pytest-dev/pytest/issues/1609 .. _1422: https://github.com/pytest-dev/pytest/issues/1422 .. _1379: https://github.com/pytest-dev/pytest/issues/1379 .. _1366: https://github.com/pytest-dev/pytest/issues/1366 .. _1040: https://github.com/pytest-dev/pytest/pull/1040 .. _680: https://github.com/pytest-dev/pytest/issues/680 .. _1287: https://github.com/pytest-dev/pytest/pull/1287 .. _1226: https://github.com/pytest-dev/pytest/pull/1226 .. _1290: https://github.com/pytest-dev/pytest/pull/1290 .. _1355: https://github.com/pytest-dev/pytest/pull/1355 .. _1397: https://github.com/pytest-dev/pytest/issues/1397 .. _biern: https://github.com/biern .. _MichaelAquilina: https://github.com/MichaelAquilina .. _bukzor: https://github.com/bukzor .. _hpk42: https://github.com/hpk42 .. _nicoddemus: https://github.com/nicoddemus .. _jab: https://github.com/jab .. _codewarrior0: https://github.com/codewarrior0 .. _jaraco: https://github.com/jaraco .. _The-Compiler: https://github.com/The-Compiler .. _Shinkenjoe: https://github.com/Shinkenjoe .. _tomviner: https://github.com/tomviner .. _RonnyPfannschmidt: https://github.com/RonnyPfannschmidt .. _rabbbit: https://github.com/rabbbit .. _hackebrot: https://github.com/hackebrot .. _pquentin: https://github.com/pquentin .. _ioggstream: https://github.com/ioggstream

2.8.7

  • fix 1338: use predictable object resolution for monkeypatch

    2.8.6

  • fix 1259: allow for double nodeids in junitxml, this was a regression failing plugins combinations like pytest-pep8 + pytest-flakes
  • Workaround for exception that occurs in pyreadline when using --pdb with standard I/O capture enabled. Thanks Erik M. Bray for the PR.
  • fix 900: Better error message in case the target of a monkeypatch call raises an ImportError.
  • fix 1292: monkeypatch calls (setattr, setenv, etc.) are now O(1). Thanks David R. MacIver for the report and Bruno Oliveira for the PR.
  • fix 1223: captured stdout and stderr are now properly displayed before entering pdb when --pdb is used instead of being thrown away. Thanks Cal Leeming for the PR.
  • fix 1305: pytest warnings emitted during pytest_terminal_summary are now properly displayed. Thanks Ionel Maries Cristian for the report and Bruno Oliveira for the PR.
  • fix 628: fixed internal UnicodeDecodeError when doctests contain unicode. Thanks Jason R. Coombs for the report and Bruno Oliveira for the PR.
  • fix 1334: Add captured stdout to jUnit XML report on setup error. Thanks Georgy Dyuldin for the PR.

    2.8.5

  • fix 1243: fixed issue where class attributes injected during collection could break pytest. PR by Alexei Kozlenok, thanks Ronny Pfannschmidt and Bruno Oliveira for the review and help.
  • fix 1074: precompute junitxml chunks instead of storing the whole tree in objects Thanks Bruno Oliveira for the report and Ronny Pfannschmidt for the PR
  • fix 1238: fix pytest.deprecated_call() receiving multiple arguments (Regression introduced in 2.8.4). Thanks Alex Gaynor for the report and Bruno Oliveira for the PR.

    2.8.4

  • fix 1190: deprecated_call() now works when the deprecated function has been already called by another test in the same module. Thanks Mikhail Chernykh for the report and Bruno Oliveira for the PR.
  • fix 1198: --pastebin option now works on Python 3. Thanks Mehdy Khoshnoody for the PR.
  • fix 1219: --pastebin now works correctly when captured output contains non-ascii characters. Thanks Bruno Oliveira for the PR.
  • fix 1204: another error when collecting with a nasty getattr(). Thanks Florian Bruhin for the PR.
  • fix the summary printed when no tests did run. Thanks Florian Bruhin for the PR.
  • fix 1185 - ensure MANIFEST.in exactly matches what should go to a sdist
  • a number of documentation modernizations wrt good practices. Thanks Bruno Oliveira for the PR.

    2.8.3

  • fix 1169: add name attribute to testcases in TestCaseFunction to support the unittest.skip decorator on functions and methods. Thanks Lee Kamentsky for the PR.
  • fix 1035: collecting tests if test module level obj has getattr(). Thanks Suor for the report and Bruno Oliveira / Tom Viner for the PR.
  • fix 331: don't collect tests if their failure cannot be reported correctly e.g. they are a callable instance of a class.
  • fix 1133: fixed internal error when filtering tracebacks where one entry belongs to a file which is no longer available. Thanks Bruno Oliveira for the PR.
  • enhancement made to highlight in red the name of the failing tests so they stand out in the output. Thanks Gabriel Reis for the PR.
  • add more talks to the documentation
  • extend documentation on the --ignore cli option
  • use pytest-runner for setuptools integration
  • minor fixes for interaction with OS X El Capitan system integrity protection (thanks Florian)

    2.8.2

  • fix 1085: proper handling of encoding errors when passing encoded byte strings to pytest.parametrize in Python 2. Thanks Themanwithoutaplan for the report and Bruno Oliveira for the PR.
  • fix 1087: handling SystemError when passing empty byte strings to pytest.parametrize in Python 3. Thanks Paul Kehrer for the report and Bruno Oliveira for the PR.
  • fix 995: fixed internal error when filtering tracebacks where one entry was generated by an exec() statement. Thanks Daniel Hahler, Ashley C Straw, Philippe Gauthier and Pavel Savchenko for contributing and Bruno Oliveira for the PR.
  • fix 1100 and 1057: errors when using autouse fixtures and doctest modules. Thanks Sergey B Kirpichev and Vital Kudzelka for contributing and Bruno Oliveira for the PR.

    2.8.1

  • fix 1034: Add missing nodeid on pytest_logwarning call in addhook. Thanks Simon Gomizelj for the PR.
  • 'deprecated_call' is now only satisfied with a DeprecationWarning or PendingDeprecationWarning. Before 2.8.0, it accepted any warning, and 2.8.0 made it accept only DeprecationWarning (but not PendingDeprecationWarning). Thanks Alex Gaynor for the issue and Eric Hunsberger for the PR.
  • fix issue 1073: avoid calling getattr on potential plugin objects. This fixes an incompatibility with pytest-django. Thanks Andreas Pelme, Bruno Oliveira and Ronny Pfannschmidt for contributing and Holger Krekel for the fix.
  • Fix issue 704: handle versionconflict during plugin loading more gracefully. Thanks Bruno Oliveira for the PR.
  • Fix issue 1064: ""--junitxml" regression when used with the "pytest-xdist" plugin, with test reports being assigned to the wrong tests. Thanks Daniel Grunwald for the report and Bruno Oliveira for the PR.
  • (experimental) adapt more SEMVER style versioning and change meaning of master branch in git repo: "master" branch now keeps the bugfixes, changes aimed for micro releases. "features" branch will only be be released with minor or major pytest releases.
  • Fix issue 766 by removing documentation references to distutils. Thanks Russel Winder.
  • Fix issue 1030: now byte-strings are escaped to produce item node ids to make them always serializable. Thanks Andy Freeland for the report and Bruno Oliveira for the PR.
  • Python 2: if unicode parametrized values are convertible to ascii, their ascii representation is used for the node id.
  • Fix issue 411: Add eq method to assertion comparison example. Thanks Ben Webb.
  • Fix issue 653: deprecated_call can be used as context manager.
  • fix issue 877: properly handle assertion explanations with non-ascii repr Thanks Mathieu Agopian for the report and Ronny Pfannschmidt for the PR.
  • fix issue 1029: transform errors when writing cache values into pytest-warnings

    2.8.0

  • new --lf and -ff options to run only the last failing tests or "failing tests first" from the last run. This functionality is provided through porting the formerly external pytest-cache plugin into pytest core. BACKWARD INCOMPAT: if you used pytest-cache's functionality to persist data between test runs be aware that we don't serialize sets anymore. Thanks Ronny Pfannschmidt for most of the merging work.
  • "-r" option now accepts "a" to include all possible reports, similar to passing "fEsxXw" explicitly (isse960). Thanks Abhijeet Kasurde for the PR.
  • avoid python3.5 deprecation warnings by introducing version specific inspection helpers, thanks Michael Droettboom.
  • fix issue562: nose.tools.istest now fully respected.
  • fix issue934: when string comparison fails and a diff is too large to display without passing -vv, still show a few lines of the diff. Thanks Florian Bruhin for the report and Bruno Oliveira for the PR.
  • fix issue736: Fix a bug where fixture params would be discarded when combined with parametrization markers. Thanks to Markus Unterwaditzer for the PR.
  • fix issue710: introduce ALLOW_UNICODE doctest option: when enabled, the u prefix is stripped from unicode strings in expected doctest output. This allows doctests which use unicode to run in Python 2 and 3 unchanged. Thanks Jason R. Coombs for the report and Bruno Oliveira for the PR.
  • parametrize now also generates meaningful test IDs for enum, regex and class objects (as opposed to class instances). Thanks to Florian Bruhin for the PR.
  • Add 'warns' to assert that warnings are thrown (like 'raises'). Thanks to Eric Hunsberger for the PR.
  • Fix issue683: Do not apply an already applied mark. Thanks ojake for the PR.
  • Deal with capturing failures better so fewer exceptions get lost to /dev/null. Thanks David Szotten for the PR.
  • fix issue730: deprecate and warn about the --genscript option. Thanks Ronny Pfannschmidt for the report and Christian Pommranz for the PR.
  • fix issue751: multiple parametrize with ids bug if it parametrizes class with two or more test methods. Thanks Sergey Chipiga for reporting and Jan Bednarik for PR.
  • fix issue82: avoid loading conftest files from setup.cfg/pytest.ini/tox.ini files and upwards by default (--confcutdir can still be set to override this). Thanks Bruno Oliveira for the PR.
  • fix issue768: docstrings found in python modules were not setting up session fixtures. Thanks Jason R. Coombs for reporting and Bruno Oliveira for the PR.
  • added tmpdir_factory, a session-scoped fixture that can be used to create directories under the base temporary directory. Previously this object was installed as a _tmpdirhandler attribute of the config object, but now it is part of the official API and using config._tmpdirhandler is deprecated. Thanks Bruno Oliveira for the PR.
  • fix issue808: pytest's internal assertion rewrite hook now implements the optional PEP302 get_data API so tests can access data files next to them. Thanks xmo-odoo for request and example and Bruno Oliveira for the PR.
  • rootdir and inifile are now displayed during usage errors to help users diagnose problems such as unexpected ini files which add unknown options being picked up by pytest. Thanks to Pavel Savchenko for bringing the problem to attention in 821 and Bruno Oliveira for the PR.
  • Summary bar now is colored yellow for warning situations such as: all tests either were skipped or xpass/xfailed, or no tests were run at all (this is a partial fix for issue500).
  • fix issue812: pytest now exits with status code 5 in situations where no tests were run at all, such as the directory given in the command line does not contain any tests or as result of a command line option filters all out all tests (-k for example). Thanks Eric Siegerman (issue812) and Bruno Oliveira for the PR.
  • Summary bar now is colored yellow for warning situations such as: all tests either were skipped or xpass/xfailed, or no tests were run at all (related to issue500). Thanks Eric Siegerman.
  • New testpaths ini option: list of directories to search for tests when executing pytest from the root directory. This can be used to speed up test collection when a project has well specified directories for tests, being usually more practical than configuring norecursedirs for all directories that do not contain tests. Thanks to Adrian for idea (694) and Bruno Oliveira for the PR.
  • fix issue713: JUnit XML reports for doctest failures. Thanks Punyashloka Biswal.
  • fix issue970: internal pytest warnings now appear as "pytest-warnings" in the terminal instead of "warnings", so it is clear for users that those warnings are from pytest and not from the builtin "warnings" module. Thanks Bruno Oliveira.
  • Include setup and teardown in junitxml test durations. Thanks Janne Vanhala.
  • fix issue735: assertion failures on debug versions of Python 3.4+
  • new option --import-mode to allow to change test module importing behaviour to append to sys.path instead of prepending. This better allows to run test modules against installated versions of a package even if the package under test has the same import root. In this example::

    testing/__init__.py
    testing/test_pkg_under_test.py
    pkg_under_test/

    the tests will run against the installed version of pkg_under_test when --import-mode=append is used whereas by default they would always pick up the local version. Thanks Holger Krekel.

  • pytester: add method TmpTestdir.delete_loaded_modules(), and call it from inline_run() to allow temporary modules to be reloaded. Thanks Eduardo Schettino.
  • internally refactor pluginmanager API and code so that there is a clear distinction between a pytest-agnostic rather simple pluginmanager and the PytestPluginManager which adds a lot of behaviour, among it handling of the local conftest files. In terms of documented methods this is a backward compatible change but it might still break 3rd party plugins which relied on details like especially the pluginmanager.add_shutdown() API. Thanks Holger Krekel.
  • pluginmanagement: introduce pytest.hookimpl and pytest.hookspec decorators for setting impl/spec specific parameters. This substitutes the previous now deprecated use of pytest.mark which is meant to contain markers for test functions only.
  • write/refine docs for "writing plugins" which now have their own page and are separate from the "using/installing plugins`` page.
  • fix issue732: properly unregister plugins from any hook calling sites allowing to have temporary plugins during test execution.
  • deprecate and warn about __multicall__ argument in hook implementations. Use the hookwrapper mechanism instead already introduced with pytest-2.7.
  • speed up pytest's own test suite considerably by using inprocess tests by default (testrun can be modified with --runpytest=subprocess to create subprocesses in many places instead). The main APIs to run pytest in a test is "runpytest()" or "runpytest_subprocess" and "runpytest_inprocess" if you need a particular way of running the test. In all cases you get back a RunResult but the inprocess one will also have a "reprec" attribute with the recorded events/reports.
  • fix monkeypatch.setattr("x.y", raising=False) to actually not raise if "y" is not a pre-existing attribute. Thanks Florian Bruhin.
  • fix issue741: make running output from testdir.run copy/pasteable Thanks Bruno Oliveira.
  • add a new --noconftest argument which ignores all conftest.py files.
  • add file and line attributes to JUnit-XML output.
  • fix issue890: changed extension of all documentation files from txt to rst. Thanks to Abhijeet for the PR.
  • fix issue714: add ability to apply indirect=True parameter on particular argnames. Thanks Elizaveta239.
  • fix issue890: changed extension of all documentation files from txt to rst. Thanks to Abhijeet for the PR.
  • fix issue957: " doctest: SKIP" option will now register doctests as SKIPPED rather than PASSED. Thanks Thomas Grainger for the report and Bruno Oliveira for the PR.
  • issue951: add new record_xml_property fixture, that supports logging additional information on xml output. Thanks David Diaz for the PR.
  • issue949: paths after normal options (for example -s, -v, etc) are now properly used to discover rootdir and ini files. Thanks Peter Lauri for the report and Bruno Oliveira for the PR.

    2.7.3

  • Allow 'dev', 'rc', or other non-integer version strings in importorskip. Thanks to Eric Hunsberger for the PR.
  • fix issue856: consider --color parameter in all outputs (for example --fixtures). Thanks Barney Gale for the report and Bruno Oliveira for the PR.
  • fix issue855: passing str objects as plugins argument to pytest.main is now interpreted as a module name to be imported and registered as a plugin, instead of silently having no effect. Thanks xmo-odoo for the report and Bruno Oliveira for the PR.
  • fix issue744: fix for ast.Call changes in Python 3.5+. Thanks Guido van Rossum, Matthias Bussonnier, Stefan Zimmermann and Thomas Kluyver.
  • fix issue842: applying markers in classes no longer propagate this markers to superclasses which also have markers. Thanks xmo-odoo for the report and Bruno Oliveira for the PR.
  • preserve warning functions after call to pytest.deprecated_call. Thanks Pieter Mulder for PR.
  • fix issue854: autouse yield_fixtures defined as class members of unittest.TestCase subclasses now work as expected. Thannks xmo-odoo for the report and Bruno Oliveira for the PR.
  • fix issue833: --fixtures now shows all fixtures of collected test files, instead of just the fixtures declared on the first one. Thanks Florian Bruhin for reporting and Bruno Oliveira for the PR.
  • fix issue863: skipped tests now report the correct reason when a skip/xfail condition is met when using multiple markers. Thanks Raphael Pierzina for reporting and Bruno Oliveira for the PR.
  • optimized tmpdir fixture initialization, which should make test sessions faster (specially when using pytest-xdist). The only visible effect is that now pytest uses a subdirectory in the $TEMP directory for all directories created by this fixture (defaults to $TEMP/pytest-$USER). Thanks Bruno Oliveira for the PR.

    2.7.2

  • fix issue767: pytest.raises value attribute does not contain the exception instance on Python 2.6. Thanks Eric Siegerman for providing the test case and Bruno Oliveira for PR.
  • Automatically create directory for junitxml and results log. Thanks Aron Curzon.
  • fix issue713: JUnit XML reports for doctest failures. Thanks Punyashloka Biswal.
  • fix issue735: assertion failures on debug versions of Python 3.4+ Thanks Benjamin Peterson.
  • fix issue114: skipif marker reports to internal skipping plugin; Thanks Floris Bruynooghe for reporting and Bruno Oliveira for the PR.
  • fix issue748: unittest.SkipTest reports to internal pytest unittest plugin. Thanks Thomas De Schampheleire for reporting and Bruno Oliveira for the PR.
  • fix issue718: failed to create representation of sets containing unsortable elements in python 2. Thanks Edison Gustavo Muenz.
  • fix issue756, fix issue752 (and similar issues): depend on py-1.4.29 which has a refined algorithm for traceback generation.

    2.7.1

  • fix issue731: do not get confused by the braces which may be present and unbalanced in an object's repr while collapsing False explanations. Thanks Carl Meyer for the report and test case.
  • fix issue553: properly handling inspect.getsourcelines failures in FixtureLookupError which would lead to to an internal error, obfuscating the original problem. Thanks talljosh for initial diagnose/patch and Bruno Oliveira for final patch.
  • fix issue660: properly report scope-mismatch-access errors independently from ordering of fixture arguments. Also avoid the pytest internal traceback which does not provide information to the user. Thanks Holger Krekel.
  • streamlined and documented release process. Also all versions (in setup.py and documentation generation) are now read from _pytest/init.py. Thanks Holger Krekel.
  • fixed docs to remove the notion that yield-fixtures are experimental. They are here to stay :) Thanks Bruno Oliveira.
  • Support building wheels by using environment markers for the requirements. Thanks Ionel Maries Cristian.
  • fixed regression to 2.6.4 which surfaced e.g. in lost stdout capture printing when tests raised SystemExit. Thanks Holger Krekel.
  • reintroduced _pytest fixture of the pytester plugin which is used at least by pytest-xdist.

    2.7.0

  • fix issue435: make reload() work when assert rewriting is active. Thanks Daniel Hahler.
  • fix issue616: conftest.py files and their contained fixutres are now properly considered for visibility, independently from the exact current working directory and test arguments that are used. Many thanks to Eric Siegerman and his PR235 which contains systematic tests for conftest visibility and now passes. This change also introduces the concept of a rootdir which is printed as a new pytest header and documented in the pytest customize web page.
  • change reporting of "diverted" tests, i.e. tests that are collected in one file but actually come from another (e.g. when tests in a test class come from a base class in a different file). We now show the nodeid and indicate via a postfix the other file.
  • add ability to set command line options by environment variable PYTEST_ADDOPTS.
  • added documentation on the new pytest-dev teams on bitbucket and github. See https://pytest.org/latest/contributing.html . Thanks to Anatoly for pushing and initial work on this.
  • fix issue650: new option --docttest-ignore-import-errors which will turn import errors in doctests into skips. Thanks Charles Cloud for the complete PR.
  • fix issue655: work around different ways that cause python2/3 to leak sys.exc_info into fixtures/tests causing failures in 3rd party code
  • fix issue615: assertion re-writing did not correctly escape % signs when formatting boolean operations, which tripped over mixing booleans with modulo operators. Thanks to Tom Viner for the report, triaging and fix.
  • implement issue351: add ability to specify parametrize ids as a callable to generate custom test ids. Thanks Brianna Laugher for the idea and implementation.
  • introduce and document new hookwrapper mechanism useful for plugins which want to wrap the execution of certain hooks for their purposes. This supersedes the undocumented __multicall__ protocol which pytest itself and some external plugins use. Note that pytest-2.8 is scheduled to drop supporting the old __multicall__ and only support the hookwrapper protocol.
  • majorly speed up invocation of plugin hooks
  • use hookwrapper mechanism in builtin pytest plugins.
  • add a doctest ini option for doctest flags, thanks Holger Peters.
  • add note to docs that if you want to mark a parameter and the parameter is a callable, you also need to pass in a reason to disambiguate it from the "decorator" case. Thanks Tom Viner.
  • "python_classes" and "python_functions" options now support glob-patterns for test discovery, as discussed in issue600. Thanks Ldiary Translations.
  • allow to override parametrized fixtures with non-parametrized ones and vice versa (bubenkoff).
  • fix issue463: raise specific error for 'parameterize' misspelling (pfctdayelise).
  • On failure, the sys.last_value, sys.last_type and sys.last_traceback are set, so that a user can inspect the error via postmortem debugging (almarklein).

    2.6.4

  • Improve assertion failure reporting on iterables, by using ndiff and pprint.
  • removed outdated japanese docs from source tree.
  • docs for "pytest_addhooks" hook. Thanks Bruno Oliveira.
  • updated plugin index docs. Thanks Bruno Oliveira.
  • fix issue557: with "-k" we only allow the old style "-" for negation at the beginning of strings and even that is deprecated. Use "not" instead. This should allow to pick parametrized tests where "-" appeared in the parameter.
  • fix issue604: Escape % character in the assertion message.
  • fix issue620: add explanation in the --genscript target about what the binary blob means. Thanks Dinu Gherman.
  • fix issue614: fixed pastebin support.
  • fix issue620: add explanation in the --genscript target about what the binary blob means. Thanks Dinu Gherman.
  • fix issue614: fixed pastebin support.

    2.6.3

  • fix issue575: xunit-xml was reporting collection errors as failures instead of errors, thanks Oleg Sinyavskiy.
  • fix issue582: fix setuptools example, thanks Laszlo Papp and Ronny Pfannschmidt.
  • Fix infinite recursion bug when pickling capture.EncodedFile, thanks Uwe Schmitt.
  • fix issue589: fix bad interaction with numpy and others when showing exceptions. Check for precise "maximum recursion depth exceed" exception instead of presuming any RuntimeError is that one (implemented in py dep). Thanks Charles Cloud for analysing the issue.
  • fix conftest related fixture visibility issue: when running with a CWD outside of a test package pytest would get fixture discovery wrong. Thanks to Wolfgang Schnerring for figuring out a reproducable example.
  • Introduce pytest_enter_pdb hook (needed e.g. by pytest_timeout to cancel the timeout when interactively entering pdb). Thanks Wolfgang Schnerring.
  • check xfail/skip also with non-python function test items. Thanks Floris Bruynooghe.

    2.6.2

  • Added function pytest.freeze_includes(), which makes it easy to embed pytest into executables using tools like cx_freeze. See docs for examples and rationale. Thanks Bruno Oliveira.
  • Improve assertion rewriting cache invalidation precision.
  • fixed issue561: adapt autouse fixture example for python3.
  • fixed issue453: assertion rewriting issue with repr containing "\n{", "\n}" and "\n~".
  • fix issue560: correctly display code if an "else:" or "finally:" is followed by statements on the same line.
  • Fix example in monkeypatch documentation, thanks t-8ch.
  • fix issue572: correct tmpdir doc example for python3.
  • Do not mark as universal wheel because Python 2.6 is different from other builds due to the extra argparse dependency. Fixes issue566. Thanks sontek.
  • Implement issue549: user-provided assertion messages now no longer replace the py.test introspection message but are shown in addition to them.

    2.6.1

  • No longer show line numbers in the --verbose output, the output is now purely the nodeid. The line number is still shown in failure reports. Thanks Floris Bruynooghe.
  • fix issue437 where assertion rewriting could cause pytest-xdist slaves to collect different tests. Thanks Bruno Oliveira.
  • fix issue555: add "errors" attribute to capture-streams to satisfy some distutils and possibly other code accessing sys.stdout.errors.
  • fix issue547 capsys/capfd also work when output capturing ("-s") is disabled.
  • address issue170: allow pytest.mark.xfail(...) to specify expected exceptions via an optional "raises=EXC" argument where EXC can be a single exception or a tuple of exception classes. Thanks David Mohr for the complete PR.
  • fix integration of pytest with unittest.mock.patch decorator when it uses the "new" argument. Thanks Nicolas Delaby for test and PR.
  • fix issue with detecting conftest files if the arguments contain "::" node id specifications (copy pasted from "-v" output)
  • fix issue544 by only removing "NUM" at the end of "::" separated parts and if the part has an ".py" extension
  • don't use py.std import helper, rather import things directly. Thanks Bruno Oliveira.

    2.6

  • Cache exceptions from fixtures according to their scope (issue 467).
  • fix issue537: Avoid importing old assertion reinterpretation code by default.
  • fix issue364: shorten and enhance tracebacks representation by default. The new "--tb=auto" option (default) will only display long tracebacks for the first and last entry. You can get the old behaviour of printing all entries as long entries with "--tb=long". Also short entries by default are now printed very similarly to "--tb=native" ones.
  • fix issue514: teach assertion reinterpretation about private class attributes
  • change -v output to include full node IDs of tests. Users can copy a node ID from a test run, including line number, and use it as a positional argument in order to run only a single test.
  • fix issue 475: fail early and comprehensible if calling pytest.raises with wrong exception type.
  • fix issue516: tell in getting-started about current dependencies.
  • cleanup setup.py a bit and specify supported versions. Thanks Jurko Gospodnetic for the PR.
  • change XPASS colour to yellow rather then red when tests are run with -v.
  • fix issue473: work around mock putting an unbound method into a class dict when double-patching.
  • fix issue498: if a fixture finalizer fails, make sure that the fixture is still invalidated.
  • fix issue453: the result of the pytest_assertrepr_compare hook now gets it's newlines escaped so that format_exception does not blow up.
  • internal new warning system: pytest will now produce warnings when it detects oddities in your test collection or execution. Warnings are ultimately sent to a new pytest_logwarning hook which is currently only implemented by the terminal plugin which displays warnings in the summary line and shows more details when -rw (report on warnings) is specified.
  • change skips into warnings for test classes with an init and callables in test modules which look like a test but are not functions.
  • fix issue436: improved finding of initial conftest files from command line arguments by using the result of parse_known_args rather than the previous flaky heuristics. Thanks Marc Abramowitz for tests and initial fixing approaches in this area.
  • fix issue 479: properly handle nose/unittest(2) SkipTest exceptions during collection/loading of test modules. Thanks to Marc Schlaich for the complete PR.
  • fix issue490: include pytest_load_initial_conftests in documentation and improve docstring.
  • fix issue472: clarify that pytest.config.getvalue() cannot work if it's triggered ahead of command line parsing.
  • merge PR123: improved integration with mock.patch decorator on tests.
  • fix issue412: messing with stdout/stderr FD-level streams is now captured without crashes.
  • fix issue483: trial/py33 works now properly. Thanks Daniel Grana for PR.
  • improve example for pytest integration with "python setup.py test" which now has a generic "-a" or "--pytest-args" option where you can pass additional options as a quoted string. Thanks Trevor Bekolay.
  • simplified internal capturing mechanism and made it more robust against tests or setups changing FD1/FD2, also better integrated now with pytest.pdb() in single tests.
  • improvements to pytest's own test-suite leakage detection, courtesy of PRs from Marc Abramowitz
  • fix issue492: avoid leak in test_writeorg. Thanks Marc Abramowitz.
  • fix issue493: don't run tests in doc directory with python setup.py test (use tox -e doctesting for that)
  • fix issue486: better reporting and handling of early conftest loading failures
  • some cleanup and simplification of internal conftest handling.
  • work a bit harder to break reference cycles when catching exceptions. Thanks Jurko Gospodnetic.
  • fix issue443: fix skip examples to use proper comparison. Thanks Alex Groenholm.
  • support nose-style __test__ attribute on modules, classes and functions, including unittest-style Classes. If set to False, the test will not be collected.
  • fix issue512: show "<notset>" for arguments which might not be set in monkeypatch plugin. Improves output in documentation.

    2.5.2

  • fix issue409 -- better interoperate with cx_freeze by not trying to import from collections.abc which causes problems for py27/cx_freeze. Thanks Wolfgang L. for reporting and tracking it down.
  • fixed docs and code to use "pytest" instead of "py.test" almost everywhere. Thanks Jurko Gospodnetic for the complete PR.
  • fix issue425: mention at end of "py.test -h" that --markers and --fixtures work according to specified test path (or current dir)
  • fix issue413: exceptions with unicode attributes are now printed correctly also on python2 and with pytest-xdist runs. (the fix requires py-1.4.20)
  • copy, cleanup and integrate py.io capture from pylib 1.4.20.dev2 (rev 13d9af95547e)
  • address issue416: clarify docs as to conftest.py loading semantics
  • fix issue429: comparing byte strings with non-ascii chars in assert expressions now work better. Thanks Floris Bruynooghe.
  • make capfd/capsys.capture private, its unused and shouldnt be exposed

    2.5.1

  • merge new documentation styling PR from Tobias Bieniek.
  • fix issue403: allow parametrize of multiple same-name functions within a collection node. Thanks Andreas Kloeckner and Alex Gaynor for reporting and analysis.
  • Allow parameterized fixtures to specify the ID of the parameters by adding an ids argument to pytest.fixture() and pytest.yield_fixture(). Thanks Floris Bruynooghe.
  • fix issue404 by always using the binary xml escape in the junitxml plugin. Thanks Ronny Pfannschmidt.
  • fix issue407: fix addoption docstring to point to argparse instead of optparse. Thanks Daniel D. Wright.

    2.5.0

  • dropped python2.5 from automated release testing of pytest itself which means it's probably going to break soon (but still works with this release we believe).
  • simplified and fixed implementation for calling finalizers when parametrized fixtures or function arguments are involved. finalization is now performed lazily at setup time instead of in the "teardown phase". While this might sound odd at first, it helps to ensure that we are correctly handling setup/teardown even in complex code. User-level code should not be affected unless it's implementing the pytest_runtest_teardown hook and expecting certain fixture instances are torn down within (very unlikely and would have been unreliable anyway).
  • PR90: add --color=yes|no|auto option to force terminal coloring mode ("auto" is default). Thanks Marc Abramowitz.
  • fix issue319 - correctly show unicode in assertion errors. Many thanks to Floris Bruynooghe for the complete PR. Also means we depend on py>=1.4.19 now.
  • fix issue396 - correctly sort and finalize class-scoped parametrized tests independently from number of methods on the class.
  • refix issue323 in a better way -- parametrization should now never cause Runtime Recursion errors because the underlying algorithm for re-ordering tests per-scope/per-fixture is not recursive anymore (it was tail-call recursive before which could lead to problems for more than >966 non-function scoped parameters).
  • fix issue290 - there is preliminary support now for parametrizing with repeated same values (sometimes useful to to test if calling a second time works as with the first time).
  • close issue240 - document precisely how pytest module importing works, discuss the two common test directory layouts, and how it interacts with PEP420-namespace packages.
  • fix issue246 fix finalizer order to be LIFO on independent fixtures depending on a parametrized higher-than-function scoped fixture. (was quite some effort so please bear with the complexity of this sentence :) Thanks Ralph Schmitt for the precise failure example.
  • fix issue244 by implementing special index for parameters to only use indices for paramentrized test ids
  • fix issue287 by running all finalizers but saving the exception from the first failing finalizer and re-raising it so teardown will still have failed. We reraise the first failing exception because it might be the cause for other finalizers to fail.
  • fix ordering when mock.patch or other standard decorator-wrappings are used with test methods. This fixues issue346 and should help with random "xdist" collection failures. Thanks to Ronny Pfannschmidt and Donald Stufft for helping to isolate it.
  • fix issue357 - special case "-k" expressions to allow for filtering with simple strings that are not valid python expressions. Examples: "-k 1.3" matches all tests parametrized with 1.3. "-k None" filters all tests that have "None" in their name and conversely "-k 'not None'". Previously these examples would raise syntax errors.
  • fix issue384 by removing the trial support code since the unittest compat enhancements allow trial to handle it on its own
  • don't hide an ImportError when importing a plugin produces one. fixes issue375.
  • fix issue275 - allow usefixtures and autouse fixtures for running doctest text files.
  • fix issue380 by making --resultlog only rely on longrepr instead of the "reprcrash" attribute which only exists sometimes.
  • address issue122: allow pytest.fixture(params=iterator) by exploding into a list early on.
  • fix pexpect-3.0 compatibility for pytest's own tests. (fixes issue386)
  • allow nested parametrize-value markers, thanks James Lan for the PR.
  • fix unicode handling with new monkeypatch.setattr(import_path, value) API. Thanks Rob Dennis. Fixes issue371.
  • fix unicode handling with junitxml, fixes issue368.
  • In assertion rewriting mode on Python 2, fix the detection of coding cookies. See issue 330.
  • make "--runxfail" turn imperative pytest.xfail calls into no ops (it already did neutralize pytest.mark.xfail markers)
  • refine pytest / pkg_resources interactions: The AssertionRewritingHook PEP302 compliant loader now registers itself with setuptools/pkg_resources properly so that the pkg_resources.resource_stream method works properly. Fixes issue366. Thanks for the investigations and full PR to Jason R. Coombs.
  • pytestconfig fixture is now session-scoped as it is the same object during the whole test run. Fixes issue370.
  • avoid one surprising case of marker malfunction/confusion::

    pytest.mark.some(lambda arg: ...) def test_function():

    would not work correctly because pytest assumes pytest.mark.some gets a function to be decorated already. We now at least detect if this arg is an lambda and thus the example will work. Thanks Alex Gaynor for bringing it up.

  • xfail a test on pypy that checks wrong encoding/ascii (pypy does not error out). fixes issue385.
  • internally make varnames() deal with classes's init, although it's not needed by pytest itself atm. Also fix caching. Fixes issue376.
  • fix issue221 - handle importing of namespace-package with no init.py properly.
  • refactor internal FixtureRequest handling to avoid monkeypatching. One of the positive user-facing effects is that the "request" object can now be used in closures.
  • fixed version comparison in pytest.importskip(modname, minverstring)
  • fix issue377 by clarifying in the nose-compat docs that pytest does not duplicate the unittest-API into the "plain" namespace.
  • fix verbose reporting for mock'd test functions

    2.4.2

  • on Windows require colorama and a newer py lib so that py.io.TerminalWriter() now uses colorama instead of its own ctypes hacks. (fixes issue365) thanks Paul Moore for bringing it up.
  • fix "-k" matching of tests where "repr" and "attr" and other names would cause wrong matches because of an internal implementation quirk (don't ask) which is now properly implemented. fixes issue345.
  • avoid tmpdir fixture to create too long filenames especially when parametrization is used (issue354)
  • fix pytest-pep8 and pytest-flakes / pytest interactions (collection names in mark plugin was assuming an item always has a function which is not true for those plugins etc.) Thanks Andi Zeidler.
  • introduce node.get_marker/node.add_marker API for plugins like pytest-pep8 and pytest-flakes to avoid the messy details of the node.keywords pseudo-dicts. Adapted docs.
  • remove attempt to "dup" stdout at startup as it's icky. the normal capturing should catch enough possibilities of tests messing up standard FDs.
  • add pluginmanager.do_configure(config) as a link to config.do_configure() for plugin-compatibility

    2.4.1

  • When using parser.addoption() unicode arguments to the "type" keyword should also be converted to the respective types. thanks Floris Bruynooghe, dnozay. (fixes issue360 and issue362)
  • fix dotted filename completion when using argcomplete thanks Anthon van der Neuth. (fixes issue361)
  • fix regression when a 1-tuple ("arg",) is used for specifying parametrization (the values of the parametrization were passed nested in a tuple). Thanks Donald Stufft.
  • merge doc typo fixes, thanks Andy Dirnberger

    2.4

known incompatibilities:

  • if calling --genscript from python2.7 or above, you only get a standalone script which works on python2.7 or above. Use Python2.6 to also get a python2.5 compatible version.
  • all xunit-style teardown methods (nose-style, pytest-style, unittest-style) will not be called if the corresponding setup method failed, see issue322 below.
  • the pytest_plugin_unregister hook wasn't ever properly called and there is no known implementation of the hook - so it got removed.
  • pytest.fixture-decorated functions cannot be generators (i.e. use yield) anymore. This change might be reversed in 2.4.1 if it causes unforeseen real-life issues. However, you can always write and return an inner function/generator and change the fixture consumer to iterate over the returned generator. This change was done in lieu of the new pytest.yield_fixture decorator, see below.

new features:

  • experimentally introduce a new pytest.yield_fixture decorator which accepts exactly the same parameters as pytest.fixture but mandates a yield statement instead of a return statement from fixture functions. This allows direct integration with "with-style" context managers in fixture functions and generally avoids registering of finalization callbacks in favour of treating the "after-yield" as teardown code. Thanks Andreas Pelme, Vladimir Keleshev, Floris Bruynooghe, Ronny Pfannschmidt and many others for discussions.
  • allow boolean expression directly with skipif/xfail if a "reason" is also specified. Rework skipping documentation to recommend "condition as booleans" because it prevents surprises when importing markers between modules. Specifying conditions as strings will remain fully supported.
  • reporting: color the last line red or green depending if failures/errors occurred or everything passed. thanks Christian Theunert.
  • make "import pdb ; pdb.set_trace()" work natively wrt capturing (no "-s" needed anymore), making pytest.set_trace() a mere shortcut.
  • fix issue181: --pdb now also works on collect errors (and on internal errors) . This was implemented by a slight internal refactoring and the introduction of a new hook pytest_exception_interact hook (see next item).
  • fix issue341: introduce new experimental hook for IDEs/terminals to intercept debugging: pytest_exception_interact(node, call, report).
  • new monkeypatch.setattr() variant to provide a shorter invocation for patching out classes/functions from modules:

    monkeypatch.setattr("requests.get", myfunc)

    will replace the "get" function of the "requests" module with myfunc.

  • fix issue322: tearDownClass is not run if setUpClass failed. Thanks Mathieu Agopian for the initial fix. Also make all of pytest/nose finalizer mimick the same generic behaviour: if a setupX exists and fails, don't run teardownX. This internally introduces a new method "node.addfinalizer()" helper which can only be called during the setup phase of a node.
  • simplify pytest.mark.parametrize() signature: allow to pass a CSV-separated string to specify argnames. For example: pytest.mark.parametrize(&quot;input,expected&quot;, [(1,2), (2,3)]) works as well as the previous: pytest.mark.parametrize((&quot;input&quot;, &quot;expected&quot;), ...).
  • add support for setUpModule/tearDownModule detection, thanks Brian Okken.
  • integrate tab-completion on options through use of "argcomplete". Thanks Anthon van der Neut for the PR.
  • change option names to be hyphen-separated long options but keep the old spelling backward compatible. py.test -h will only show the hyphenated version, for example "--collect-only" but "--collectonly" will remain valid as well (for backward-compat reasons). Many thanks to Anthon van der Neut for the implementation and to Hynek Schlawack for pushing us.
  • fix issue 308 - allow to mark/xfail/skip individual parameter sets when parametrizing. Thanks Brianna Laugher.
  • call new experimental pytest_load_initial_conftests hook to allow 3rd party plugins to do something before a conftest is loaded.

Bug fixes:

  • fix issue358 - capturing options are now parsed more properly by using a new parser.parse_known_args method.
  • pytest now uses argparse instead of optparse (thanks Anthon) which means that "argparse" is added as a dependency if installing into python2.6 environments or below.
  • fix issue333: fix a case of bad unittest/pytest hook interaction.
  • PR27: correctly handle nose.SkipTest during collection. Thanks Antonio Cuni, Ronny Pfannschmidt.
  • fix issue355: junitxml puts name="pytest" attribute to testsuite tag.
  • fix issue336: autouse fixture in plugins should work again.
  • fix issue279: improve object comparisons on assertion failure for standard datatypes and recognise collections.abc. Thanks to Brianna Laugher and Mathieu Agopian.
  • fix issue317: assertion rewriter support for the is_package method
  • fix issue335: document py.code.ExceptionInfo() object returned from pytest.raises(), thanks Mathieu Agopian.
  • remove implicit distribute_setup support from setup.py.
  • fix issue305: ignore any problems when writing pyc files.
  • SO-17664702: call fixture finalizers even if the fixture function partially failed (finalizers would not always be called before)
  • fix issue320 - fix class scope for fixtures when mixed with module-level functions. Thanks Anatloy Bubenkoff.
  • you can specify "-q" or "-qq" to get different levels of "quieter" reporting (thanks Katarzyna Jachim)
  • fix issue300 - Fix order of conftest loading when starting py.test in a subdirectory.
  • fix issue323 - sorting of many module-scoped arg parametrizations
  • make sessionfinish hooks execute with the same cwd-context as at session start (helps fix plugin behaviour which write output files with relative path such as pytest-cov)
  • fix issue316 - properly reference collection hooks in docs
  • fix issue 306 - cleanup of -k/-m options to only match markers/test names/keywords respectively. Thanks Wouter van Ackooy.
  • improved doctest counting for doctests in python modules -- files without any doctest items will not show up anymore and doctest examples are counted as separate test items. thanks Danilo Bellini.
  • fix issue245 by depending on the released py-1.4.14 which fixes py.io.dupfile to work with files with no mode. Thanks Jason R. Coombs.
  • fix junitxml generation when test output contains control characters, addressing issue267, thanks Jaap Broekhuizen
  • fix issue338: honor --tb style for setup/teardown errors as well. Thanks Maho.
  • fix issue307 - use yaml.safe_load in example, thanks Mark Eichin.
  • better parametrize error messages, thanks Brianna Laugher
  • pytest_terminal_summary(terminalreporter) hooks can now use ".section(title)" and ".line(msg)" methods to print extra information at the end of a test run.

    2.3.5

  • fix issue169: respect --tb=style with setup/teardown errors as well.
  • never consider a fixture function for test function collection
  • allow re-running of test items / helps to fix pytest-reruntests plugin and also help to keep less fixture/resource references alive
  • put captured stdout/stderr into junitxml output even for passing tests (thanks Adam Goucher)
  • Issue 265 - integrate nose setup/teardown with setupstate so it doesnt try to teardown if it did not setup
  • issue 271 - dont write junitxml on slave nodes
  • Issue 274 - dont try to show full doctest example when doctest does not know the example location
  • issue 280 - disable assertion rewriting on buggy CPython 2.6.0
  • inject "getfixture()" helper to retrieve fixtures from doctests, thanks Andreas Zeidler
  • issue 259 - when assertion rewriting, be consistent with the default source encoding of ASCII on Python 2
  • issue 251 - report a skip instead of ignoring classes with init
  • issue250 unicode/str mixes in parametrization names and values now works
  • issue257, assertion-triggered compilation of source ending in a comment line doesn't blow up in python2.5 (fixed through py>=1.4.13.dev6)
  • fix --genscript option to generate standalone scripts that also work with python3.3 (importer ordering)
  • issue171 - in assertion rewriting, show the repr of some global variables
  • fix option help for "-k"
  • move long description of distribution into README.rst
  • improve docstring for metafunc.parametrize()
  • fix bug where using capsys with pytest.set_trace() in a test function would break when looking at capsys.readouterr()
  • allow to specify prefixes starting with "_" when customizing python_functions test discovery. (thanks Graham Horler)
  • improve PYTEST_DEBUG tracing output by puting extra data on a new lines with additional indent
  • ensure OutcomeExceptions like skip/fail have initialized exception attributes
  • issue 260 - don't use nose special setup on plain unittest cases
  • fix issue134 - print the collect errors that prevent running specified test items
  • fix issue266 - accept unicode in MarkEvaluator expressions

    2.3.4

  • yielded test functions will now have autouse-fixtures active but cannot accept fixtures as funcargs - it's anyway recommended to rather use the post-2.0 parametrize features instead of yield, see: http://pytest.org/latest/example/parametrize.html
  • fix autouse-issue where autouse-fixtures would not be discovered if defined in a a/conftest.py file and tests in a/tests/test_some.py
  • fix issue226 - LIFO ordering for fixture teardowns
  • fix issue224 - invocations with >256 char arguments now work
  • fix issue91 - add/discuss package/directory level setups in example
  • allow to dynamically define markers via item.keywords[...]=assignment integrating with "-m" option
  • make "-k" accept an expressions the same as with "-m" so that one can write: -k "name1 or name2" etc. This is a slight incompatibility if you used special syntax like "TestClass.test_method" which you now need to write as -k "TestClass and test_method" to match a certain method in a certain test class.

    2.3.3

  • fix issue214 - parse modules that contain special objects like e. g. flask's request object which blows up on getattr access if no request is active. thanks Thomas Waldmann.
  • fix issue213 - allow to parametrize with values like numpy arrays that do not support an eq operator
  • fix issue215 - split test_python.org into multiple files
  • fix issue148 - unittest.skip on classes is now recognized and avoids calling setUpClass/tearDownClass, thanks Pavel Repin
  • fix issue209 - reintroduce python2.4 support by depending on newer pylib which re-introduced statement-finding for pre-AST interpreters
  • nose support: only call setup if its a callable, thanks Andrew Taumoefolau
  • fix issue219 - add py2.4-3.3 classifiers to TROVE list
  • in tracebacks ,* arg values are now shown next to normal arguments (thanks Manuel Jacob)
  • fix issue217 - support mock.patch with pytest's fixtures - note that you need either mock-1.0.1 or the python3.3 builtin unittest.mock.
  • fix issue127 - improve documentation for pytest_addoption() and add a config.getoption(name) helper function for consistency.

    2.3.2

  • fix issue208 and fix issue29 use new py version to avoid long pauses when printing tracebacks in long modules
  • fix issue205 - conftests in subdirs customizing pytest_pycollect_makemodule and pytest_pycollect_makeitem now work properly
  • fix teardown-ordering for parametrized setups
  • fix issue127 - better documentation for pytest_addoption and related objects.
  • fix unittest behaviour: TestCase.runtest only called if there are test methods defined
  • improve trial support: don't collect its empty unittest.TestCase.runTest() method
  • "python setup.py test" now works with pytest itself
  • fix/improve internal/packaging related bits:
    • exception message check of test_nose.py now passes on python33 as well
    • issue206 - fix test_assertrewrite.py to work when a global PYTHONDONTWRITEBYTECODE=1 is present
    • add tox.ini to pytest distribution so that ignore-dirs and others config bits are properly distributed for maintainers who run pytest-own tests

      2.3.1

  • fix issue202 - fix regression: using "self" from fixture functions now works as expected (it's the same "self" instance that a test method which uses the fixture sees)
  • skip pexpect using tests (test_pdb.py mostly) on freebsd* systems due to pexpect not supporting it properly (hanging)
  • link to web pages from --markers output which provides help for pytest.mark.* usage.

    2.3.0

  • fix issue202 - better automatic names for parametrized test functions
  • fix issue139 - introduce pytest.fixture which allows direct scoping and parametrization of funcarg factories.
  • fix issue198 - conftest fixtures were not found on windows32 in some circumstances with nested directory structures due to path manipulation issues
  • fix issue193 skip test functions with were parametrized with empty parameter sets
  • fix python3.3 compat, mostly reporting bits that previously depended on dict ordering
  • introduce re-ordering of tests by resource and parametrization setup which takes precedence to the usual file-ordering
  • fix issue185 monkeypatching time.time does not cause pytest to fail
  • fix issue172 duplicate call of pytest.fixture decoratored setup_module functions
  • fix junitxml=path construction so that if tests change the current working directory and the path is a relative path it is constructed correctly from the original current working dir.
  • fix "python setup.py test" example to cause a proper "errno" return
  • fix issue165 - fix broken doc links and mention stackoverflow for FAQ
  • catch unicode-issues when writing failure representations to terminal to prevent the whole session from crashing
  • fix xfail/skip confusion: a skip-mark or an imperative pytest.skip will now take precedence before xfail-markers because we can't determine xfail/xpass status in case of a skip. see also: http://stackoverflow.com/questions/11105828/in-py-test-when-i-explicitly-skip-a-test-that-is-marked-as-xfail-how-can-i-get
  • always report installed 3rd party plugins in the header of a test run
  • fix issue160: a failing setup of an xfail-marked tests should be reported as xfail (not xpass)
  • fix issue128: show captured output when capsys/capfd are used
  • fix issue179: propperly show the dependency chain of factories
  • pluginmanager.register(...) now raises ValueError if the plugin has been already registered or the name is taken
  • fix issue159: improve http://pytest.org/latest/faq.html especially with respect to the "magic" history, also mention pytest-django, trial and unittest integration.
  • make request.keywords and node.keywords writable. All descendant collection nodes will see keyword values. Keywords are dictionaries containing markers and other info.
  • fix issue 178: xml binary escapes are now wrapped in py.xml.raw
  • fix issue 176: correctly catch the builtin AssertionError even when we replaced AssertionError with a subclass on the python level
  • factory discovery no longer fails with magic global callables that provide no sane code object (mock.call for example)
  • fix issue 182: testdir.inprocess_run now considers passed plugins
  • fix issue 188: ensure sys.exc_info is clear on python2 before calling into a test
  • fix issue 191: add unittest TestCase runTest method support
  • fix issue 156: monkeypatch correctly handles class level descriptors
  • reporting refinements:
    • pytest_report_header now receives a "startdir" so that you can use startdir.bestrelpath(yourpath) to show nice relative path
    • allow plugins to implement both pytest_report_header and pytest_sessionstart (sessionstart is invoked first).
    • don't show deselected reason line if there is none
    • py.test -vv will show all of assert comparisations instead of truncating

      2.2.4

  • fix error message for rewritten assertions involving the % operator
  • fix issue 126: correctly match all invalid xml characters for junitxml binary escape
  • fix issue with unittest: now unittest.expectedFailure markers should be processed correctly (you can also use pytest.mark markers)
  • document integration with the extended distribute/setuptools test commands
  • fix issue 140: propperly get the real functions of bound classmethods for setup/teardown_class
  • fix issue 141: switch from the deceased paste.pocoo.org to bpaste.net
  • fix issue 143: call unconfigure/sessionfinish always when configure/sessionstart where called
  • fix issue 144: better mangle test ids to junitxml classnames
  • upgrade distribute_setup.py to 0.6.27

    2.2.3

  • fix uploaded package to only include neccesary files

    2.2.2

  • fix issue101: wrong args to unittest.TestCase test function now produce better output
  • fix issue102: report more useful errors and hints for when a test directory was renamed and some pyc/pycache remain
  • fix issue106: allow parametrize to be applied multiple times e.g. from module, class and at function level.
  • fix issue107: actually perform session scope finalization
  • don't check in parametrize if indirect parameters are funcarg names
  • add chdir method to monkeypatch funcarg
  • fix crash resulting from calling monkeypatch undo a second time
  • fix issue115: make --collectonly robust against early failure (missing files/directories)
  • "-qq --collectonly" now shows only files and the number of tests in them
  • "-q --collectonly" now shows test ids
  • allow adding of attributes to test reports such that it also works with distributed testing (no upgrade of pytest-xdist needed)

    2.2.1

  • fix issue99 (in pytest and py) internallerrors with resultlog now produce better output - fixed by normalizing pytest_internalerror input arguments.
  • fix issue97 / traceback issues (in pytest and py) improve traceback output in conjunction with jinja2 and cython which hack tracebacks
  • fix issue93 (in pytest and pytest-xdist) avoid "delayed teardowns": the final test in a test node will now run its teardown directly instead of waiting for the end of the session. Thanks Dave Hunt for the good reporting and feedback. The pytest_runtest_protocol as well as the pytest_runtest_teardown hooks now have "nextitem" available which will be None indicating the end of the test run.
  • fix collection crash due to unknown-source collected items, thanks to Ralf Schmitt (fixed by depending on a more recent pylib)

    2.2.0

  • fix issue90: introduce eager tearing down of test items so that teardown function are called earlier.
  • add an all-powerful metafunc.parametrize function which allows to parametrize test function arguments in multiple steps and therefore from indepdenent plugins and palces.
  • add a pytest.mark.parametrize helper which allows to easily call a test function with different argument values
  • Add examples to the "parametrize" example page, including a quick port of Test scenarios and the new parametrize function and decorator.
  • introduce registration for "pytest.mark.*" helpers via ini-files or through plugin hooks. Also introduce a "--strict" option which will treat unregistered markers as errors allowing to avoid typos and maintain a well described set of markers for your test suite. See exaples at http://pytest.org/latest/mark.html and its links.
  • issue50: introduce "-m marker" option to select tests based on markers (this is a stricter and more predictable version of '-k' in that "-m" only matches complete markers and has more obvious rules for and/or semantics.
  • new feature to help optimizing the speed of your tests: --durations=N option for displaying N slowest test calls and setup/teardown methods.
  • fix issue87: --pastebin now works with python3
  • fix issue89: --pdb with unexpected exceptions in doctest work more sensibly
  • fix and cleanup pytest's own test suite to not leak FDs
  • fix issue83: link to generated funcarg list
  • fix issue74: pyarg module names are now checked against imp.find_module false positives
  • fix compatibility with twisted/trial-11.1.0 use cases
  • simplify Node.listchain
  • simplify junitxml output code by relying on py.xml
  • add support for skip properties on unittest classes and functions

    2.1.3

  • fix issue79: assertion rewriting failed on some comparisons in boolops
  • correctly handle zero length arguments (a la pytest '')
  • fix issue67 / junitxml now contains correct test durations, thanks ronny
  • fix issue75 / skipping test failure on jython
  • fix issue77 / Allow assertrepr_compare hook to apply to a subset of tests

    2.1.2

  • fix assertion rewriting on files with windows newlines on some Python versions
  • refine test discovery by package/module name (--pyargs), thanks Florian Mayer
  • fix issue69 / assertion rewriting fixed on some boolean operations
  • fix issue68 / packages now work with assertion rewriting
  • fix issue66: use different assertion rewriting caches when the -O option is passed
  • don't try assertion rewriting on Jython, use reinterp

    2.1.1

  • fix issue64 / pytest.set_trace now works within pytest_generate_tests hooks
  • fix issue60 / fix error conditions involving the creation of pycache
  • fix issue63 / assertion rewriting on inserts involving strings containing '%'
  • fix assertion rewriting on calls with a \ arg
  • don't cache rewritten modules if bytecode generation is disabled
  • fix assertion rewriting in read-only directories
  • fix issue59: provide system-out/err tags for junitxml output
  • fix issue61: assertion rewriting on boolean operations with 3 or more operands
  • you can now build a man page with "cd doc ; make man"

    2.1.0

  • fix issue53 call nosestyle setup functions with correct ordering
  • fix issue58 and issue59: new assertion code fixes
  • merge Benjamin's assertionrewrite branch: now assertions for test modules on python 2.6 and above are done by rewriting the AST and saving the pyc file before the test module is imported. see doc/assert.txt for more info.
  • fix issue43: improve doctests with better traceback reporting on unexpected exceptions
  • fix issue47: timing output in junitxml for test cases is now correct
  • fix issue48: typo in MarkInfo repr leading to exception
  • fix issue49: avoid confusing error when initizaliation partially fails
  • fix issue44: env/username expansion for junitxml file path
  • show releaselevel information in test runs for pypy
  • reworked doc pages for better navigation and PDF generation
  • report KeyboardInterrupt even if interrupted during session startup
  • fix issue 35 - provide PDF doc version and download link from index page

    2.0.3

  • fix issue38: nicer tracebacks on calls to hooks, particularly early configure/sessionstart ones
  • fix missing skip reason/meta information in junitxml files, reported via http://lists.idyll.org/pipermail/testing-in-python/2011-March/003928.html
  • fix issue34: avoid collection failure with "test" prefixed classes deriving from object.
  • don't require zlib (and other libs) for genscript plugin without --genscript actually being used.
  • speed up skips (by not doing a full traceback represenation internally)
  • fix issue37: avoid invalid characters in junitxml's output

    2.0.2

  • tackle issue32 - speed up test runs of very quick test functions by reducing the relative overhead
  • fix issue30 - extended xfail/skipif handling and improved reporting. If you have a syntax error in your skip/xfail expressions you now get nice error reports.

    Also you can now access module globals from xfail/skipif expressions so that this for example works now::

    import pytest import mymodule pytest.mark.skipif("mymodule.version[0] == "1") def test_function(): pass

    This will not run the test function if the module's version string does not start with a "1". Note that specifying a string instead of a boolean expressions allows py.test to report meaningful information when summarizing a test run as to what conditions lead to skipping (or xfail-ing) tests.

  • fix issue28 - setup_method and pytest_generate_tests work together The setup_method fixture method now gets called also for test function invocations generated from the pytest_generate_tests hook.
  • fix issue27 - collectonly and keyword-selection (-k) now work together Also, if you do "py.test --collectonly -q" you now get a flat list of test ids that you can use to paste to the py.test commandline in order to execute a particular test.
  • fix issue25 avoid reported problems with --pdb and python3.2/encodings output
  • fix issue23 - tmpdir argument now works on Python3.2 and WindowsXP Starting with Python3.2 os.symlink may be supported. By requiring a newer py lib version the py.path.local() implementation acknowledges this.
  • fixed typos in the docs (thanks Victor Garcia, Brianna Laugher) and particular thanks to Laura Creighton who also revieved parts of the documentation.
  • fix slighly wrong output of verbose progress reporting for classes (thanks Amaury)
  • more precise (avoiding of) deprecation warnings for node.Class|Function accesses
  • avoid std unittest assertion helper code in tracebacks (thanks Ronny)

    2.0.1

  • refine and unify initial capturing so that it works nicely even if the logging module is used on an early-loaded conftest.py file or plugin.
  • allow to omit "()" in test ids to allow for uniform test ids as produced by Alfredo's nice pytest.vim plugin.
  • fix issue12 - show plugin versions with "--version" and "--traceconfig" and also document how to add extra information to reporting test header
  • fix issue17 (import-* reporting issue on python3) by requiring py>1.4.0 (1.4.1 is going to include it)
  • fix issue10 (numpy arrays truth checking) by refining assertion interpretation in py lib
  • fix issue15: make nose compatibility tests compatible with python3 (now that nose-1.0 supports python3)
  • remove somewhat surprising "same-conftest" detection because it ignores conftest.py when they appear in several subdirs.
  • improve assertions ("not in"), thanks Floris Bruynooghe
  • improve behaviour/warnings when running on top of "python -OO" (assertions and docstrings are turned off, leading to potential false positives)
  • introduce a pytest_cmdline_processargs(args) hook to allow dynamic computation of command line arguments. This fixes a regression because py.test prior to 2.0 allowed to set command line options from conftest.py files which so far pytest-2.0 only allowed from ini-files now.
  • fix issue7: assert failures in doctest modules. unexpected failures in doctests will not generally show nicer, i.e. within the doctest failing context.
  • fix issue9: setup/teardown functions for an xfail-marked test will report as xfail if they fail but report as normally passing (not xpassing) if they succeed. This only is true for "direct" setup/teardown invocations because teardown_class/ teardown_module cannot closely relate to a single test.
  • fix issue14: no logging errors at process exit
  • refinements to "collecting" output on non-ttys
  • refine internal plugin registration and --traceconfig output
  • introduce a mechanism to prevent/unregister plugins from the command line, see http://pytest.org/plugins.htmlcmdunregister
  • activate resultlog plugin by default
  • fix regression wrt yielded tests which due to the collection-before-running semantics were not setup as with pytest 1.3.4. Note, however, that the recommended and much cleaner way to do test parametraization remains the "pytest_generate_tests" mechanism, see the docs.

    2.0.0

  • pytest-2.0 is now its own package and depends on pylib-2.0
  • new ability: python -m pytest / python -m pytest.main ability
  • new python invcation: pytest.main(args, plugins) to load some custom plugins early.
  • try harder to run unittest test suites in a more compatible manner by deferring setup/teardown semantics to the unittest package. also work harder to run twisted/trial and Django tests which should now basically work by default.
  • introduce a new way to set config options via ini-style files, by default setup.cfg and tox.ini files are searched. The old ways (certain environment variables, dynamic conftest.py reading is removed).
  • add a new "-q" option which decreases verbosity and prints a more nose/unittest-style "dot" output.
  • fix issue135 - marks now work with unittest test cases as well
  • fix issue126 - introduce py.test.set_trace() to trace execution via PDB during the running of tests even if capturing is ongoing.
  • fix issue123 - new "python -m py.test" invocation for py.test (requires Python 2.5 or above)
  • fix issue124 - make reporting more resilient against tests opening files on filedescriptor 1 (stdout).
  • fix issue109 - sibling conftest.py files will not be loaded. (and Directory collectors cannot be customized anymore from a Directory's conftest.py - this needs to happen at least one level up).
  • introduce (customizable) assertion failure representations and enhance output on assertion failures for comparisons and other cases (Floris Bruynooghe)
  • nose-plugin: pass through type-signature failures in setup/teardown functions instead of not calling them (Ed Singleton)
  • remove py.test.collect.Directory (follows from a major refactoring and simplification of the collection process)
  • majorly reduce py.test core code, shift function/python testing to own plugin
  • fix issue88 (finding custom test nodes from command line arg)
  • refine 'tmpdir' creation, will now create basenames better associated with test names (thanks Ronny)
  • "xpass" (unexpected pass) tests don't cause exitcode!=0
  • fix issue131 / issue60 - importing doctests in init files used as namespace packages
  • fix issue93 stdout/stderr is captured while importing conftest.py
  • fix bug: unittest collected functions now also can have "pytestmark" applied at class/module level
  • add ability to use "class" level for cached_setup helper
  • fix strangeness: mark.* objects are now immutable, create new instances

    1.3.4

  • fix issue111: improve install documentation for windows
  • fix issue119: fix custom collectability of init.py as a module
  • fix issue116: --doctestmodules work with init.py files as well
  • fix issue115: unify internal exception passthrough/catching/GeneratorExit
  • fix issue118: new --tb=native for presenting cpython-standard exceptions

    1.3.3

  • fix issue113: assertion representation problem with triple-quoted strings (and possibly other cases)
  • make conftest loading detect that a conftest file with the same content was already loaded, avoids surprises in nested directory structures which can be produced e.g. by Hudson. It probably removes the need to use --confcutdir in most cases.
  • fix terminal coloring for win32 (thanks Michael Foord for reporting)
  • fix weirdness: make terminal width detection work on stdout instead of stdin (thanks Armin Ronacher for reporting)
  • remove trailing whitespace in all py/text distribution files

    1.3.2

New features

  • fix issue103: introduce py.test.raises as context manager, examples::

    with py.test.raises(ZeroDivisionError): x = 0 1 / x

    with py.test.raises(RuntimeError) as excinfo: call_something()

    you may do extra checks on excinfo.value|type|traceback here

    (thanks Ronny Pfannschmidt)

  • Funcarg factories can now dynamically apply a marker to a test invocation. This is for example useful if a factory provides parameters to a test which are expected-to-fail::

    def pytest_funcarg__arg(request): request.applymarker(py.test.mark.xfail(reason="flaky config")) ...

    def test_function(arg): ...

  • improved error reporting on collection and import errors. This makes use of a more general mechanism, namely that for custom test item/collect nodes node.repr_failure(excinfo) is now uniformly called so that you can override it to return a string error representation of your choice which is going to be reported as a (red) string.
  • introduce '--junitprefix=STR' option to prepend a prefix to all reports in the junitxml file.

Bug fixes

  • make tests and the pytest_recwarn plugin in particular fully compatible to Python2.7 (if you use the recwarn funcarg warnings will be enabled so that you can properly check for their existence in a cross-python manner).
  • refine --pdb: ignore xfailed tests, unify its TB-reporting and don't display failures again at the end.
  • fix assertion interpretation with the \ operator (thanks Benjamin Peterson)
  • fix issue105 assignment on the same line as a failing assertion (thanks Benjamin Peterson)
  • fix issue104 proper escaping for test names in junitxml plugin (thanks anonymous)
  • fix issue57 -f|--looponfail to work with xpassing tests (thanks Ronny)
  • fix issue92 collectonly reporter and --pastebin (thanks Benjamin Peterson)
  • fix py.code.compile(source) to generate unique filenames
  • fix assertion re-interp problems on PyPy, by defering code compilation to the (overridable) Frame.eval class. (thanks Amaury Forgeot)
  • fix py.path.local.pyimport() to work with directories
  • streamline py.path.local.mkdtemp implementation and usage
  • don't print empty lines when showing junitxml-filename
  • add optional boolean ignore_errors parameter to py.path.local.remove
  • fix terminal writing on win32/python2.4
  • py.process.cmdexec() now tries harder to return properly encoded unicode objects on all python versions
  • install plain py.test/py.which scripts also for Jython, this helps to get canonical script paths in virtualenv situations
  • make path.bestrelpath(path) return ".", note that when calling X.bestrelpath the assumption is that X is a directory.
  • make initial conftest discovery ignore "--" prefixed arguments
  • fix resultlog plugin when used in an multicpu/multihost xdist situation (thanks Jakub Gustak)
  • perform distributed testing related reporting in the xdist-plugin rather than having dist-related code in the generic py.test distribution
  • fix homedir detection on Windows
  • ship distribute_setup.py version 0.6.13

    1.3.1

New features

  • issue91: introduce new py.test.xfail(reason) helper to imperatively mark a test as expected to fail. Can be used from within setup and test functions. This is useful especially for parametrized tests when certain configurations are expected-to-fail. In this case the declarative approach with the py.test.mark.xfail cannot be used as it would mark all configurations as xfail.
  • issue102: introduce new --maxfail=NUM option to stop test runs after NUM failures. This is a generalization of the '-x' or '--exitfirst' option which is now equivalent to '--maxfail=1'. Both '-x' and '--maxfail' will now also print a line near the end indicating the Interruption.
  • issue89: allow py.test.mark decorators to be used on classes (class decorators were introduced with python2.6) and also allow to have multiple markers applied at class/module level by specifying a list.
  • improve and refine letter reporting in the progress bar: . pass f failed test s skipped tests (reminder: use for dependency/platform mismatch only) x xfailed test (test that was expected to fail) X xpassed test (test that was expected to fail but passed)

    You can use any combination of 'fsxX' with the '-r' extended reporting option. The xfail/xpass results will show up as skipped tests in the junitxml output - which also fixes issue99.

  • make py.test.cmdline.main() return the exitstatus instead of raising SystemExit and also allow it to be called multiple times. This of course requires that your application and tests are properly teared down and don't have global state.

Bug Fixes

  • improved traceback presentation:
    • improved and unified reporting for "--tb=short" option
    • Errors during test module imports are much shorter, (using --tb=short style)
    • raises shows shorter more relevant tracebacks
    • --fulltrace now more systematically makes traces longer / inhibits cutting
  • improve support for raises and other dynamically compiled code by manipulating python's linecache.cache instead of the previous rather hacky way of creating custom code objects. This makes it seemlessly work on Jython and PyPy where it previously didn't.
  • fix issue96: make capturing more resilient against Control-C interruptions (involved somewhat substantial refactoring to the underlying capturing functionality to avoid race conditions).
  • fix chaining of conditional skipif/xfail decorators - so it works now as expected to use multiple py.test.mark.skipif(condition) decorators, including specific reporting which of the conditions lead to skipping.
  • fix issue95: late-import zlib so that it's not required for general py.test startup.
  • fix issue94: make reporting more robust against bogus source code (and internally be more careful when presenting unexpected byte sequences)

    1.3.0

  • deprecate --report option in favour of a new shorter and easier to remember -r option: it takes a string argument consisting of any combination of 'xfsX' characters. They relate to the single chars you see during the dotted progress printing and will print an extra line per test at the end of the test run. This extra line indicates the exact position or test ID that you directly paste to the py.test cmdline in order to re-run a particular test.
  • allow external plugins to register new hooks via the new pytest_addhooks(pluginmanager) hook. The new release of the pytest-xdist plugin for distributed and looponfailing testing requires this feature.
  • add a new pytest_ignore_collect(path, config) hook to allow projects and plugins to define exclusion behaviour for their directory structure - for example you may define in a conftest.py this method::

    def pytest_ignore_collect(path):
       return path.check(link=1)

    to prevent even a collection try of any tests in symlinked dirs.

  • new pytest_pycollect_makemodule(path, parent) hook for allowing customization of the Module collection object for a matching test module.
  • extend and refine xfail mechanism: py.test.mark.xfail(run=False) do not run the decorated test py.test.mark.xfail(reason=&quot;...&quot;) prints the reason string in xfail summaries specifiying --runxfail on command line virtually ignores xfail markers
  • expose (previously internal) commonly useful methods: py.io.get_terminal_with() -> return terminal width py.io.ansi_print(...) -> print colored/bold text on linux/win32 py.io.saferepr(obj) -> return limited representation string
  • expose test outcome related exceptions as py.test.skip.Exception, py.test.raises.Exception etc., useful mostly for plugins doing special outcome interpretation/tweaking
  • (issue85) fix junitxml plugin to handle tests with non-ascii output
  • fix/refine python3 compatibility (thanks Benjamin Peterson)
  • fixes for making the jython/win32 combination work, note however: jython2.5.1/win32 does not provide a command line launcher, see http://bugs.jython.org/issue1491 . See pylib install documentation for how to work around.
  • fixes for handling of unicode exception values and unprintable objects
  • (issue87) fix unboundlocal error in assertionold code
  • (issue86) improve documentation for looponfailing
  • refine IO capturing: stdin-redirect pseudo-file now has a NOP close() method
  • ship distribute_setup.py version 0.6.10
  • added links to the new capturelog and coverage plugins

    1.2.0

  • refined usage and options for "py.cleanup"::

    py.cleanup remove ".pyc" and "$py.class" (jython) files py.cleanup -e .swp -e .cache also remove files with these extensions py.cleanup -s remove "build" and "dist" directory next to setup.py files py.cleanup -d also remove empty directories py.cleanup -a synonym for "-s -d -e 'pip-log.txt'" py.cleanup -n dry run, only show what would be removed

  • add a new option "py.test --funcargs" which shows available funcargs and their help strings (docstrings on their respective factory function) for a given test path
  • display a short and concise traceback if a funcarg lookup fails
  • early-load "conftest.py" files in non-dot first-level sub directories. allows to conveniently keep and access test-related options in a test subdir and still add command line options.
  • fix issue67: new super-short traceback-printing option: "--tb=line" will print a single line for each failing (python) test indicating its filename, lineno and the failure value
  • fix issue78: always call python-level teardown functions even if the according setup failed. This includes refinements for calling setup_module/class functions which will now only be called once instead of the previous behaviour where they'd be called multiple times if they raise an exception (including a Skipped exception). Any exception will be re-corded and associated with all tests in the according module/class scope.
  • fix issue63: assume <40 columns to be a bogus terminal width, default to 80
  • fix pdb debugging to be in the correct frame on raises-related errors
  • update apipkg.py to fix an issue where recursive imports might unnecessarily break importing
  • fix plugin links

    1.1.1

  • moved dist/looponfailing from py.test core into a new separately released pytest-xdist plugin.
  • new junitxml plugin: --junitxml=path will generate a junit style xml file which is processable e.g. by the Hudson CI system.
  • new option: --genscript=path will generate a standalone py.test script which will not need any libraries installed. thanks to Ralf Schmitt.
  • new option: --ignore will prevent specified path from collection. Can be specified multiple times.
  • new option: --confcutdir=dir will make py.test only consider conftest files that are relative to the specified dir.
  • new funcarg: "pytestconfig" is the pytest config object for access to command line args and can now be easily used in a test.
  • install py.test and py.which with a -$VERSION suffix to disambiguate between Python3, python2.X, Jython and PyPy installed versions.
  • new "pytestconfig" funcarg allows access to test config object
  • new "pytest_report_header" hook can return additional lines to be displayed at the header of a test run.
  • (experimental) allow "py.test path::name1::name2::..." for pointing to a test within a test collection directly. This might eventually evolve as a full substitute to "-k" specifications.
  • streamlined plugin loading: order is now as documented in customize.html: setuptools, ENV, commandline, conftest. also setuptools entry point names are turned to canonical namees ("pytest_*")
  • automatically skip tests that need 'capfd' but have no os.dup
  • allow pytest_generate_tests to be defined in classes as well
  • deprecate usage of 'disabled' attribute in favour of pytestmark
  • deprecate definition of Directory, Module, Class and Function nodes in conftest.py files. Use pytest collect hooks instead.
  • collection/item node specific runtest/collect hooks are only called exactly on matching conftest.py files, i.e. ones which are exactly below the filesystem path of an item
  • change: the first pytest_collect_directory hook to return something will now prevent further hooks to be called.
  • change: figleaf plugin now requires --figleaf to run. Also change its long command line options to be a bit shorter (see py.test -h).
  • change: pytest doctest plugin is now enabled by default and has a new option --doctest-glob to set a pattern for file matches.
  • change: remove internal py._* helper vars, only keep py._pydir
  • robustify capturing to survive if custom pytest_runtest_setup code failed and prevented the capturing setup code from running.
  • make py.test.* helpers provided by default plugins visible early - works transparently both for pydoc and for interactive sessions which will regularly see e.g. py.test.mark and py.test.importorskip.
  • simplify internal plugin manager machinery
  • simplify internal collection tree by introducing a RootCollector node
  • fix assert reinterpreation that sees a call containing "keyword=..."
  • fix issue66: invoke pytest_sessionstart and pytest_sessionfinish hooks on slaves during dist-testing, report module/session teardown hooks correctly.
  • fix issue65: properly handle dist-testing if no execnet/py lib installed remotely.
  • skip some install-tests if no execnet is available
  • fix docs, fix internal bin/ script generation

    1.1.0

  • introduce automatic plugin registration via 'pytest11' entrypoints via setuptools' pkg_resources.iter_entry_points
  • fix py.test dist-testing to work with execnet >= 1.0.0b4
  • re-introduce py.test.cmdline.main() for better backward compatibility
  • svn paths: fix a bug with path.check(versioned=True) for svn paths, allow '%' in svn paths, make svnwc.update() default to interactive mode like in 1.0.x and add svnwc.update(interactive=False) to inhibit interaction.
  • refine distributed tarball to contain test and no pyc files
  • try harder to have deprecation warnings for py.compat.* accesses report a correct location

    1.0.3

  • adjust and improve docs
  • remove py.rest tool and internal namespace - it was never really advertised and can still be used with the old release if needed. If there is interest it could be revived into its own tool i guess.
  • fix issue48 and issue59: raise an Error if the module from an imported test file does not seem to come from the filepath - avoids "same-name" confusion that has been reported repeatedly
  • merged Ronny's nose-compatibility hacks: now nose-style setup_module() and setup() functions are supported
  • introduce generalized py.test.mark function marking
  • reshuffle / refine command line grouping
  • deprecate parser.addgroup in favour of getgroup which creates option group
  • add --report command line option that allows to control showing of skipped/xfailed sections
  • generalized skipping: a new way to mark python functions with skipif or xfail at function, class and modules level based on platform or sys-module attributes.
  • extend py.test.mark decorator to allow for positional args
  • introduce and test "py.cleanup -d" to remove empty directories
  • fix issue 59 - robustify unittest test collection
  • make bpython/help interaction work by adding an all attribute to ApiModule, cleanup initpkg
  • use MIT license for pylib, add some contributors
  • remove py.execnet code and substitute all usages with 'execnet' proper
  • fix issue50 - cached_setup now caches more to expectations for test functions with multiple arguments.
  • merge Jarko's fixes, issue 45 and 46
  • add the ability to specify a path for py.lookup to search in
  • fix a funcarg cached_setup bug probably only occuring in distributed testing and "module" scope with teardown.
  • many fixes and changes for making the code base python3 compatible, many thanks to Benjamin Peterson for helping with this.
  • consolidate builtins implementation to be compatible with >=2.3, add helpers to ease keeping 2 and 3k compatible code
  • deprecate py.compat.doctest|subprocess|textwrap|optparse
  • deprecate py.magic.autopath, remove py/magic directory
  • move pytest assertion handling to py/code and a pytest_assertion plugin, add "--no-assert" option, deprecate py.magic namespaces in favour of (less) py.code ones.
  • consolidate and cleanup py/code classes and files
  • cleanup py/misc, move tests to bin-for-dist
  • introduce delattr/delitem/delenv methods to py.test's monkeypatch funcarg
  • consolidate py.log implementation, remove old approach.
  • introduce py.io.TextIO and py.io.BytesIO for distinguishing between text/unicode and byte-streams (uses underlying standard lib io.* if available)
  • make py.unittest_convert helper script available which converts "unittest.py" style files into the simpler assert/direct-test-classes py.test/nosetests style. The script was written by Laura Creighton.
  • simplified internal localpath implementation

    1.0.2

  • fixing packaging issues, triggered by fedora redhat packaging, also added doc, examples and contrib dirs to the tarball.
  • added a documentation link to the new django plugin.

    1.0.1

  • added a 'pytest_nose' plugin which handles nose.SkipTest, nose-style function/method/generator setup/teardown and tries to report functions correctly.
  • capturing of unicode writes or encoded strings to sys.stdout/err work better, also terminalwriting was adapted and somewhat unified between windows and linux.
  • improved documentation layout and content a lot
  • added a "--help-config" option to show conftest.py / ENV-var names for all longopt cmdline options, and some special conftest.py variables. renamed 'conf_capture' conftest setting to 'option_capture' accordingly.
  • fix issue 27: better reporting on non-collectable items given on commandline (e.g. pyc files)
  • fix issue 33: added --version flag (thanks Benjamin Peterson)
  • fix issue 32: adding support for "incomplete" paths to wcpath.status()
  • "Test" prefixed classes are not collected by default anymore if they have an init method
  • monkeypatch setenv() now accepts a "prepend" parameter
  • improved reporting of collection error tracebacks
  • simplified multicall mechanism and plugin architecture, renamed some internal methods and argnames

    1.0.0

  • more terse reporting try to show filesystem path relatively to current dir
  • improve xfail output a bit

    1.0.0b9

  • cleanly handle and report final teardown of test setup
  • fix svn-1.6 compat issue with py.path.svnwc().versioned() (thanks Wouter Vanden Hove)
  • setup/teardown or collection problems now show as ERRORs or with big "E"'s in the progress lines. they are reported and counted separately.
  • dist-testing: properly handle test items that get locally collected but cannot be collected on the remote side - often due to platform/dependency reasons
  • simplified py.test.mark API - see keyword plugin documentation
  • integrate better with logging: capturing now by default captures test functions and their immediate setup/teardown in a single stream
  • capsys and capfd funcargs now have a readouterr() and a close() method (underlyingly py.io.StdCapture/FD objects are used which grew a readouterr() method as well to return snapshots of captured out/err)
  • make assert-reinterpretation work better with comparisons not returning bools (reported with numpy from thanks maciej fijalkowski)
  • reworked per-test output capturing into the pytest_iocapture.py plugin and thus removed capturing code from config object
  • item.repr_failure(excinfo) instead of item.repr_failure(excinfo, outerr)

    1.0.0b8

  • pytest_unittest-plugin is now enabled by default
  • introduced pytest_keyboardinterrupt hook and refined pytest_sessionfinish hooked, added tests.
  • workaround a buggy logging module interaction ("closing already closed files"). Thanks to Sridhar Ratnakumar for triggering.
  • if plugins use "py.test.importorskip" for importing a dependency only a warning will be issued instead of exiting the testing process.
  • many improvements to docs:
    • refined funcargs doc , use the term "factory" instead of "provider"
    • added a new talk/tutorial doc page
    • better download page
    • better plugin docstrings
    • added new plugins page and automatic doc generation script
  • fixed teardown problem related to partially failing funcarg setups (thanks MrTopf for reporting), "pytest_runtest_teardown" is now always invoked even if the "pytest_runtest_setup" failed.
  • tweaked doctest output for docstrings in py modules, thanks Radomir.

    1.0.0b7

  • renamed py.test.xfail back to py.test.mark.xfail to avoid two ways to decorate for xfail
  • re-added py.test.mark decorator for setting keywords on functions (it was actually documented so removing it was not nice)
  • remove scope-argument from request.addfinalizer() because request.cached_setup has the scope arg. TOOWTDI.
  • perform setup finalization before reporting failures
  • apply modified patches from Andreas Kloeckner to allow test functions to have no func_code (22) and to make "-k" and function keywords work (20)
  • apply patch from Daniel Peolzleithner (issue 23)
  • resolve issue 18, multiprocessing.Manager() and redirection clash
  • make name == "channelexec" for remote_exec code

    1.0.0b3

  • plugin classes are removed: one now defines hooks directly in conftest.py or global pytest_*.py files.
  • added new pytest_namespace(config) hook that allows to inject helpers directly to the py.test.* namespace.
  • documented and refined many hooks
  • added new style of generative tests via pytest_generate_tests hook that integrates well with function arguments.

    1.0.0b1

  • introduced new "funcarg" setup method, see doc/test/funcarg.txt
  • introduced plugin architecture and many new py.test plugins, see doc/test/plugins.txt
  • teardown_method is now guaranteed to get called after a test method has run.
  • new method: py.test.importorskip(mod,minversion) will either import or call py.test.skip()
  • completely revised internal py.test architecture
  • new py.process.ForkedFunc object allowing to fork execution of a function to a sub process and getting a result back.

XXX lots of things missing here XXX

0.9.2

  • refined installation and metadata, created new setup.py, now based on setuptools/ez_setup (thanks to Ralf Schmitt for his support).
  • improved the way of making py.* scripts available in windows environments, they are now added to the Scripts directory as ".cmd" files.
  • py.path.svnwc.status() now is more complete and uses xml output from the 'svn' command if available (Guido Wesdorp)
  • fix for py.path.svn* to work with svn 1.5 (Chris Lamb)
  • fix path.relto(otherpath) method on windows to use normcase for checking if a path is relative.
  • py.test's traceback is better parseable from editors (follows the filenames:LINENO: MSG convention) (thanks to Osmo Salomaa)
  • fix to javascript-generation, "py.test --runbrowser" should work more reliably now
  • removed previously accidentally added py.test.broken and py.test.notimplemented helpers.
  • there now is a py.version attribute

    0.9.1

This is a fairly complete list of v0.9.1, which can serve as a reference for developers.

  • allowing + signs in py.path.svn urls [39106]
  • fixed support for Failed exceptions without excinfo in py.test [39340]
  • added support for killing processes for Windows (as well as platforms that support os.kill) in py.misc.killproc [39655]
  • added setup/teardown for generative tests to py.test [40702]
  • added detection of FAILED TO LOAD MODULE to py.test [40703, 40738, 40739]
  • fixed problem with calling .remove() on wcpaths of non-versioned files in py.path [44248]
  • fixed some import and inheritance issues in py.test [41480, 44648, 44655]
  • fail to run greenlet tests when pypy is available, but without stackless [45294]
  • small fixes in rsession tests [45295]
  • fixed issue with 2.5 type representations in py.test [45483, 45484]
  • made that internal reporting issues displaying is done atomically in py.test [45518]
  • made that non-existing files are igored by the py.lookup script [45519]
  • improved exception name creation in py.test [45535]
  • made that less threads are used in execnet [merge in 45539]
  • removed lock required for atomical reporting issue displaying in py.test [45545]
  • removed globals from execnet [45541, 45547]
  • refactored cleanup mechanics, made that setDaemon is set to 1 to make atexit get called in 2.5 (py.execnet) [45548]
  • fixed bug in joining threads in py.execnet's servemain [45549]
  • refactored py.test.rsession tests to not rely on exact output format anymore [45646]
  • using repr() on test outcome [45647]
  • added 'Reason' classes for py.test.skip() [45648, 45649]
  • killed some unnecessary sanity check in py.test.collect [45655]
  • avoid using os.tmpfile() in py.io.fdcapture because on Windows it's only usable by Administrators [45901]
  • added support for locking and non-recursive commits to py.path.svnwc [45994]
  • locking files in py.execnet to prevent CPython from segfaulting [46010]
  • added export() method to py.path.svnurl
  • fixed -d -x in py.test [47277]
  • fixed argument concatenation problem in py.path.svnwc [49423]
  • restore py.test behaviour that it exits with code 1 when there are failures [49974]
  • don't fail on html files that don't have an accompanying .txt file [50606]
  • fixed 'utestconvert.py < input' [50645]
  • small fix for code indentation in py.code.source [50755]
  • fix _docgen.py documentation building [51285]
  • improved checks for source representation of code blocks in py.test [51292]
  • added support for passing authentication to py.path.svn* objects [52000, 52001]
  • removed sorted() call for py.apigen tests in favour of [].sort() to support Python 2.3 [52481]

    pytest-cov -> 2.4.0

2.4.0


  • Added a "disarm" option: --no-cov. It will disable coverage measurements. Contributed by Zoltan Kozma in PR135 &lt;https://github.com/pytest-dev/pytest-cov/pull/135&gt;_.

    WARNING: Do not put this in your configuration files, it's meant to be an one-off for situations where you want to disable coverage from command line.

  • Fixed broken exception handling on .pth file. See 136 &lt;https://github.com/pytest-dev/pytest-cov/issues/136&gt;_.

    2.3.1


  • Fixed regression causing spurious errors when xdist was used. See 124 &lt;https://github.com/pytest-dev/pytest-cov/issues/124&gt;_.
  • Fixed DeprecationWarning about incorrect addoption use. Contributed by Florian Bruhin in PR127 &lt;https://github.com/pytest-dev/pytest-cov/pull/127&gt;_.
  • Fixed deprecated use of funcarg fixture API. Contributed by Daniel Hahler in PR125 &lt;https://github.com/pytest-dev/pytest-cov/pull/125&gt;_.

    2.3.0


  • Add support for specifying output location for html, xml, and annotate report. Contributed by Patrick Lannigan in PR113 &lt;https://github.com/pytest-dev/pytest-cov/pull/113&gt;_.
  • Fix bug hiding test failure when cov-fail-under failed.
  • For coverage >= 4.0, match the default behaviour of coverage report and error if coverage fails to find the source instead of just printing a warning. Contributed by David Szotten in PR116 &lt;https://github.com/pytest-dev/pytest-cov/pull/116&gt;_.
  • Fixed bug occurred when bare --cov parameter was used with xdist. Contributed by Michael Elovskikh in PR120 &lt;https://github.com/pytest-dev/pytest-cov/pull/120&gt;_.
  • Add support for skip_covered and added --cov-report=term-skip-covered command line options. Contributed by Saurabh Kumar in PR115 &lt;https://github.com/pytest-dev/pytest-cov/pull/115&gt;_.

    2.2.1


  • Fixed incorrect merging of coverage data when xdist was used and coverage was &gt;= 4.0.

    2.2.0


  • Added support for changing working directory in tests. Previously changing working directory would disable coverage measurements in suprocesses.
  • Fixed broken handling for --cov-report=annotate.

    2.1.0


  • Added support for coverage 4.0b2.
  • Added the --cov-append command line options. Contributed by Christian Ledermann in PR80 &lt;https://github.com/pytest-dev/pytest-cov/pull/80&gt;_.

    2.0.0


  • Added --cov-fail-under, akin to the new fail_under option in coverage-4.0 (automatically activated if there's a [report] fail_under = ... in .coveragerc).
  • Changed --cov-report=term to automatically upgrade to --cov-report=term-missing if there's [run] show_missing = True in .coveragerc.
  • Changed --cov so it can be used with no path argument (in wich case the source settings from .coveragerc will be used instead).
  • Fixed .pth installation to work in all cases (install, easy_install, wheels, develop etc).
  • Fixed .pth uninstallation to work for wheel installs.
  • Support for coverage 4.0.
  • Data file suffixing changed to use coverage's data_suffix=True option (instead of the custom suffixing).
  • Avoid warning about missing coverage data (just like coverage.control.process_startup).
  • Fixed a race condition when running with xdist (all the workers tried to combine the files). It's possible that this issue is not present in pytest-cov 1.8.X.

    1.8.2


  • N/A

Once you have closed this pull request, I'll create seperate pull requests for every update as soon as I find them.

That's it for now!

Happy merging! 🤖

codecov-io commented 7 years ago

Current coverage is 69.89% (diff: 100%)

Merging #11 into master will not change coverage

@@             master        #11   diff @@
==========================================
  Files            35         35          
  Lines          1601       1601          
  Methods           0          0          
  Messages          0          0          
  Branches          0          0          
==========================================
  Hits           1119       1119          
  Misses          482        482          
  Partials          0          0          

Sunburst

Powered by Codecov. Last update 7108c5b...f380a1a