File: test_imports.py

package info (click to toggle)
mdanalysis 2.10.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 116,696 kB
  • sloc: python: 92,135; ansic: 8,156; makefile: 215; sh: 138
file content (67 lines) | stat: -rw-r--r-- 2,510 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
# -*- Mode: python; tab-width: 4; indent-tabs-mode:nil; coding:utf-8 -*-
# vim: tabstop=4 expandtab shiftwidth=4 softtabstop=4 fileencoding=utf-8
#
# MDAnalysis --- https://www.mdanalysis.org
# Copyright (c) 2006-2017 The MDAnalysis Development Team and contributors
# (see the file AUTHORS for the full list of names)
#
# Released under the Lesser GNU Public Licence, v2.1 or any higher version
#
# Please cite your use of MDAnalysis in published work:
#
# R. J. Gowers, M. Linke, J. Barnoud, T. J. E. Reddy, M. N. Melo, S. L. Seyler,
# D. L. Dotson, J. Domanski, S. Buchoux, I. M. Kenney, and O. Beckstein.
# MDAnalysis: A Python package for the rapid analysis of molecular dynamics
# simulations. In S. Benthall and S. Rostrup editors, Proceedings of the 15th
# Python in Science Conference, pages 102-109, Austin, TX, 2016. SciPy.
# doi: 10.25080/majora-629e541a-00e
#
# N. Michaud-Agrawal, E. J. Denning, T. B. Woolf, and O. Beckstein.
# MDAnalysis: A Toolkit for the Analysis of Molecular Dynamics Simulations.
# J. Comput. Chem. 32 (2011), 2319--2327, doi:10.1002/jcc.21787
#
import os

import MDAnalysisTests
import pytest

"""Relative imports are banned in unit testing modules (Issue #189), so run tests to enforce this policy."""

path_to_testing_modules = MDAnalysisTests.__path__[0]
# Exclusion path relative to MDAnalysisTests
exclusions = ["/plugins", "/data"]


def is_excluded(path):
    leaf = path[len(path_to_testing_modules) :]
    return leaf in exclusions


def get_file_paths():
    paths = []
    for dirpath, dirnames, files in os.walk(path_to_testing_modules):
        if is_excluded(dirpath):
            continue
        for f in filter(lambda x: x.endswith(".py"), files):
            fpath = os.path.join(dirpath, f)
            if is_excluded(fpath):
                continue
            paths.append(fpath)
    return paths


@pytest.mark.parametrize("testing_module", get_file_paths())
def test_relative_import(testing_module):
    with open(testing_module, "r") as test_module_file_object:
        for lineno, line in enumerate(test_module_file_object, start=1):
            if (
                "from ." in line
                and "import" in line
                and not "test_imports" in testing_module
            ):
                raise AssertionError(
                    "A relative import statement was found in "
                    "module {testing_module} at linenumber {lineno}.".format(
                        **vars()
                    )
                )