Release Notes

wmflib Changelog

v1.0.0 (2021-11-11)

Minor improvements

  • constants: add the new drmrs datacenter to existing constants.

  • constants: add CORE_DATACENTERS constant currently defined in Spicerack.

  • Adopt pathlib.Path everywhere in the project:

    • Accept both str and os.PathLike objects in the config and fileio modules for file name parameters.

    • Use pathlib.Path instead of the os.path functions across the project.

  • style: adopt f-strings, converting all format() calls to f-strings when feasible.

  • interactive: change input prefix to ==>:

    • Change the input prefix from >>> to ==> to allow for code examples in an interactive Python console to be used in docstrings as documentation without having issues with the syntax highlighter.

  • docs: add usage examples to all modules.


  • versioning: fully adopt semantic versioning starting with this release.

  • pylint: fix newly reported issues.

v0.0.9 (2021-08-04)

Minor improvements

  • decorators: improve the @retry decorator.

    • Add a new optional dynamic_params_callbacks parameter to the @retry decorator.

    • This parameter accepts a tuple of callbacks that will be called by the decorator and allow them to modify the parameters of the decorator itself at runtime.

    • Fix the signature of retry now that the upstream bug in pylint has been fixed and the newer version is included in prospector. This allows to remove some type ingore that were required before.

  • idm: make the cn and uid arguments of logoutd_args() both required so that the logoutd scripts that adhere to this API can safely rely on both being present. The logout cookbook is already passing both parameters anyway.


  • idm: fix typo in docstring.

v0.0.8 (2021-06-23)

New features

  • idm: add a new idm module with support for global logout (T283242):

    • To ensure that all Python logout scripts will have the same set of arguments and to reduce everyone repeating the same argparse block, a LogoutdBase abstract class was added.

    • It features also a logoutd_args() function that provides the common argparse setup for all the logoutd scripts.

    • See the module’s documentation for example usages.

Minor improvements

  • constants: add DATACENTER_NUMBERING_PREFIX constant to map datacenter names to their numbering prefix used in hostnames.

Bug fixes

  • interactive: also check term for tmux in ensure_shell_is_durable().

  • tests: fix pip backtracking moving prospector tests to their own virtual environments.


  • Add official support for Python 3.9

  • fileio: uniform quotes used in the file.

  • add types dependencies for mypy for the dependencies that don’t have yet type hints.

  • CHANGELOG: fix typo in the v0.0.7 release notes.

v0.0.7 (2021-02-18)

New features

  • dns: update DNS to support multiple namservers.

    • This allows cookbooks to configure the Dns with multiple nameservers, for example:

      dns = Dns(nameserver_addresses=['', ''])

      and thus allow users to get authoritative answers whiles also making use of DNS failover to account for any on going work on a specific nameserver while the cookbook is running.

      The PUBLIC_AUTHDNS constant holds the auth server ips, given that they change very infrequently.

  • fileio: add new module to manage file I/O operations.

    • Add a locked_open() context manager to open a file with an exclusive lock to be used like the buil-in open().


  • tests: cover untested property in the irc module.

  • CHANGELOG: fix typo.

  • tests: pylint, remove unnecessary disable comments.

v0.0.6 (2021-01-04)


  • doc: improve installation and introduction documentation pages and some modules documentation.

  • type hints: mark the package as type hinted so that mypy can recognize its type hints when imported in other projects.

v0.0.5 (2020-12-21)

New features

  • Port the decorators module from Spicerack (T257905).

  • Port the interactive module from Spicerack (T257905).

  • Port the prometheus module from Spicerack (T257905).

  • Port the IRC logger handler from Spickerack into an irc module (T257905).

  • interactive: improve confirmation capabilities

    • Add a ask_input() generic function to ask the user for input and check that the answer is among a list of allowed choices, returning the user’s choice.

    • Convert ask_confirmation() to use the ask_input() function.

    • Add an InputError and AbortError exception classes.

    • Add a confirm_on_failure() function to run any callable, and on failure ask the user to either retry, skip the step or abort the whole execution.


  • docs: fix link to pywmflib Gerrit project.

  • tests: fix deprecated pytest argument.

v0.0.4 (2020-11-02)

New features

  • requests: add new requests module that exposes an http_session() function that instantiate a requests’s Session with configurable default timeout, retry logic on some failures as well as setting a well formatted User-Agent.

v0.0.3 (2020-10-23)

New features

  • Import the action module from Spicerack

  • Import the config module from Spicerack

  • Import the phabricator module from Spicerack

v0.0.2 (2020-09-22)


  • Remove Spicerack references from docstrings.

v0.0.1 (2020-07-27)

New features

  • Initial version of the package.

  • Import the dns module and tests from Spicerack.