Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions reference/tools.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1544,3 +1544,32 @@ if ``file.txt`` exists).

Parameters:
- **folder** (Required): root folder to start deleting ``._`` files.


.. _tools_version:

tools.Version()
---------------

.. code-block:: python

from conans import tools

v = tools.Version("1.2.3-dev23")
assert v < "1.2.3"

This is a helper class to work with semantic versions, built on top of ``semver.SemVer`` class
with loose parsing. It exposes all the version components as properties and offers total
ordering through compare operators.

Build the ``tools.Version`` object using any valid string or any object that converts to
string, the constructor will raise if the string is not a valid loose semver.

Properties:
- **major**: component ``major`` of semver version
- **minor**: component ``minor`` of semver version (defaults to ``"0"``)
- **patch**: component ``patch`` of semver version (defaults to ``"0"``)
- **prerelease**: component ``prerelease`` of semver version (defaults to ``""``)
- **build**: component ``build`` of semver version (defaults to ``""``). Take into account
that ``build`` component doesn't affect precedence between versions.