xdoctest

Version 1.1.3 - Released 2024-01-30

Fixed

• modname_to_modpath now handles cases where editable packages have modules where the name is different than the package.
• Update xdoctest.plugin to support pytest 8.0
• Fixed deprecated usage of ast.Num

What's Changed

• Setup dev branch for 1.1.3 by @Erotemic in https://github.com/Erotemic/xdoctest/pull/150

Full Changelog: https://github.com/Erotemic/xdoctest/compare/v1.1.2...v1.1.3

Version 1.1.2 - Released 2023-010-25

Added

• Partial support for 3.12. New f-string syntax is not supported yet.

Changed

• Removed dependency on six and got rid of old Python 2 logic

Version 1.1.1 - Released 2023-01-29

Changed

• Binary tests are now only run on "full" installs to reduce minimal dependencies.
• Support for Python 3.11
• Minor typing fixes

Fixed

• Can now handle basic versions of the new __editable__ package finder mechanism.
• Parsing bug where directives were incorrectly flagged as inline if they were
  directly followed by a function with a decorator.

Removed

• Dropped 2.7 and 3.5 support. Now supporting 3.6+ Use xdoctest<=1.0.2 for 2.7
  or 3.5 support.

Changed

• Improved the "dump" functionality of converting doctests to unit tests.

Added

• Environs as options:
  XDOCTEST_VERBOSE, XDOCTEST_OPTIONS, XDOCTEST_GLOBAL_EXEC, XDOCTEST_REPORT,
  XDOCTEST_STYLE, and XDOCTEST_ANALYSIS environment variables can now be used
  to specify configuration defaults.

Changed

• Added experimental hidden feature --insert-skip-directive-above-failures
  that can be used to modify your code such that failing doctests are marked as
  skip.
• Disabled traceback suppression on module import errors (this is is
  configurable via the "supress_import_errors" option).
• Xdoctest will no longer try to pre-import the module if none of its doctests
  have any enabled lines. This also means global-exec statements will NOT run
  for those tests, which means you can no longer use global-exec to
  force enabling tests.

Added

• Add type stubs
• Basic support for pyproject.toml under tool.xdoctest. Currently only
  supports options in the native runner.

Fixed

• Corner case bug in error reporting
• Doctests that never run any code are now correctly marked as skipped
• Issue where the "dumps" command was undocumented and has an error.

Changed

• Moved some globals into a new module called global_state and allowed
  environs to enable debug print statements.
• Added util_deprecation module to robustly mark features as deprecated.
• Modified the google style return type parser to return a type if the
  only content is some parsable python code.
• Modified docscrape google to allow for parsing of *args and **kwargs in
  args blocks. This has also moved to the standalone package googledoc
• Overhaul of repo structure in an effort to modernize and to agree with
  templates defined by xcookie
• Module code now lives in the "src" directory to remove install vs develop
  ambiguity.

There is nothing too special functionality-wise about this 1.0 release, except that xdoctest has been in a 1.0 state for a long time. It is now widely used, and it deserves to be marked as the mature and stable library that it is.

Added

• Support for Python 3.10

Fixed

• Warning in pytest8 (thanks @amolenaar)
• Spelling errors in documentation

Version 0.15.10 - Released 2021-10-06

Changed

• The xdoctest "analysis" option now defaults to "auto" everywhere.

Fixed

• Fix issue #112 --analysis=dynamic argument is now respected

Changed

• Added GitHub actions to the CI
• Disabled workaround 16806 in Python 3.8+
• New CI GPG Keys: Erotemic-CI: 70858F4D01314BF21427676F3D568E6559A34380 for
  reference the old signing key was 98007794ED130347559354B1109AC852D297D757.

Fixed

• Fixed minor test failures
• Fixed #106 - an issue to do with compiling multiline statements in single mode.
• Fixed #108 - an issue to do with compiling semicolon token in eval mode.

Version 0.15.8 - Released 2021-09-02

Changed

• Removed the distracting and very long internal traceback that occurred in
  pytest when a module errors while it is being imported before the doctest is
  run.
• Pytest now defaults to --xdoctest-verbose=2 by default (note this does
  nothing unless -s is also given so pytest does not supress output)

Yanked - contained debug print statements

Changed

• Directive syntax errors are now handled as doctest runtime errors and return better debugging information.
• README and docs were improved

Version 0.15.5 - Released 2021-06-27

Changed

• Better message when a pytest skip or exit-test-exception occurs

Fixed

• Suppressed warning about using internal FixtureRequest