File: packagepath.py

package info (click to toggle)
python-fixtures 4.2.5-4
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 408 kB
  • sloc: python: 2,547; makefile: 29; sh: 9
file content (47 lines) | stat: -rw-r--r-- 1,546 bytes parent folder | download
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
#  fixtures: Fixtures with cleanups for testing and convenience.
#
# Copyright (c) 2011, Robert Collins <robertc@robertcollins.net>
#
# Licensed under either the Apache License, Version 2.0 or the BSD 3-clause
# license at the users choice. A copy of both licenses are available in the
# project source as Apache-2.0 and BSD. You may not use this file except in
# compliance with one of these two licences.
#
# Unless required by applicable law or agreed to in writing, software
# distributed under these licenses is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
# license you chose for the specific language governing permissions and
# limitations under that license.

__all__ = [
    'PackagePathEntry',
]

import sys

from fixtures import Fixture


class PackagePathEntry(Fixture):
    """Add a path to the path of a python package.

    The python package needs to be already imported.

    If this new path is already in the packages __path__ list then the __path__
    list will not be altered.
    """

    def __init__(self, packagename, directory):
        """Create a PackagePathEntry.

        :param directory: The directory to add to the package.__path__.
        """
        self.packagename = packagename
        self.directory = directory

    def _setUp(self):
        path = sys.modules[self.packagename].__path__
        if self.directory in path:
            return
        self.addCleanup(path.remove, self.directory)
        path.append(self.directory)