Passed
Pull Request — master (#246)
by
unknown
01:39
created

gvmtools.get_version()   A

Complexity

Conditions 1

Size

Total Lines 12
Code Lines 3

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 1
eloc 3
nop 0
dl 0
loc 12
rs 10
c 0
b 0
f 0
1
# -*- coding: utf-8 -*-
2
# Copyright (C) 2018 Greenbone Networks GmbH
3
#
4
# SPDX-License-Identifier: GPL-3.0-or-later
5
#
6
# This program is free software: you can redistribute it and/or modify
7
# it under the terms of the GNU General Public License as published by
8
# the Free Software Foundation, either version 3 of the License, or
9
# (at your option) any later version.
10
#
11
# This program is distributed in the hope that it will be useful,
12
# but WITHOUT ANY WARRANTY; without even the implied warranty of
13
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14
# GNU General Public License for more details.
15
#
16
# You should have received a copy of the GNU General Public License
17
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
18
"""
19
Main module of gvm-tools.
20
"""
21
22
from pathlib import Path
23
24
from pkg_resources import safe_version
25
26
import toml
27
28
29
def get_version_from_pyproject_toml() -> str:
30
    path = Path(__file__)
31
    pyproject_toml_path = path.parent.parent / 'pyproject.toml'
32
33
    if pyproject_toml_path.exists():
34
        pyproject_toml = toml.loads(pyproject_toml_path.read_text())
35
        if 'tool' in pyproject_toml and 'poetry' in pyproject_toml['tool']:
36
            return pyproject_toml['tool']['poetry']['version']
37
38
39
def get_version() -> str:
40
    """Returns the version of gvm-tools as a string in `PEP440`_ compliant
41
    format.
42
43
    Returns:
44
        str: Current version of gvm-tools
45
46
    .. _PEP440:
47
       https://www.python.org/dev/peps/pep-0440
48
    """
49
    str_version = get_version_from_pyproject_toml()
50
    return safe_version(str_version)
51