Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add util function get_strict_version #1686

Merged
merged 2 commits into from
Jun 27, 2018
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
21 changes: 18 additions & 3 deletions aiida/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@
# For further information please visit http://www.aiida.net #
###########################################################################
import warnings

from aiida.common.log import configure_logging
from aiida.common.setup import get_property

__copyright__ = u"Copyright (c), This file is part of the AiiDA platform. For further information please visit http://www.aiida.net/. All rights reserved."
__license__ = "MIT license, see LICENSE.txt file."
__version__ = "1.0.0a1"
__version__ = "0.12.1"
__authors__ = "The AiiDA team."
__paper__ = """G. Pizzi, A. Cepellotti, R. Sabatini, N. Marzari, and B. Kozinsky, "AiiDA: automated interactive infrastructure and database for computational science", Comp. Mat. Sci 111, 218-230 (2016); http://dx.doi.org/10.1016/j.commatsci.2015.09.013 - http://www.aiida.net."""
__paper_short__ = """G. Pizzi et al., Comp. Mat. Sci 111, 218 (2016)."""
Expand All @@ -27,6 +27,7 @@
# in Python 2.7 it is suppressed by default
warnings.simplefilter('default', DeprecationWarning)


def try_load_dbenv(*argc, **argv):
"""
Run `load_dbenv` unless the dbenv has already been loaded.
Expand All @@ -36,6 +37,7 @@ def try_load_dbenv(*argc, **argv):
return True
return False


def load_dbenv(*argc, **argv):
"""
Alias for `load_dbenv` from `aiida.backends.utils`
Expand All @@ -52,9 +54,21 @@ def is_dbenv_loaded(*argc, **argv):
return is_dbenv_loaded(*argc, **argv)


def get_strict_version():
"""
Return a distutils StrictVersion instance with the current distribution version

:returns: StrictVersion instance with the current version
"""
from distutils.version import StrictVersion
return StrictVersion(__version__)


def get_version():
"""
Very simple function to get a string with the version number.
Return the current distribution version

:returns: a string with the current version
"""
return __version__

Expand All @@ -71,6 +85,7 @@ def _get_raw_file_header():
{}
""".format(__version__, __paper__)


def get_file_header(comment_char="# "):
"""
Get a string to be put as header of files created with AiiDA;
Expand All @@ -80,4 +95,4 @@ def get_file_header(comment_char="# "):
:return: a (multiline) string
"""
lines = _get_raw_file_header().splitlines()
return "\n".join("{}{}".format(comment_char, line) for line in lines)
return '\n'.join('{}{}'.format(comment_char, line) for line in lines)