Source code for gluonnlp.utils.version

# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements.  See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership.  The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License.  You may obtain a copy of the License at
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# KIND, either express or implied.  See the License for the
# specific language governing permissions and limitations
# under the License.
"""Utility functions for version checking."""
import warnings

__all__ = ['check_version']

[docs]def check_version(min_version, warning_only=False, library=None): """Check the version of gluonnlp satisfies the provided minimum version. An exception is thrown if the check does not pass. Parameters ---------- min_version : str Minimum version warning_only : bool Printing a warning instead of throwing an exception. library: optional module, default None The target library for version check. Checks gluonnlp by default """ # pylint: disable=import-outside-toplevel from .. import __version__ if library is None: version = __version__ name = 'GluonNLP' else: version = library.__version__ name = library.__name__ from packaging.version import parse bad_version = parse(version.replace('.dev', '')) < parse(min_version) if bad_version: msg = 'Installed {} version {} does not satisfy the ' \ 'minimum required version {}'.format(name, version, min_version) if warning_only: warnings.warn(msg) else: raise AssertionError(msg)