reuse.vcs module¶
This module deals with version control systems.
-
class
reuse.vcs.
VCSStrategy
(project)[source]¶ Bases:
abc.ABC
Strategy pattern for version control systems.
-
abstract classmethod
find_root
(cwd=None)[source]¶ Try to find the root of the project from cwd. If none is found, return None.
- Raises
NotADirectoryError – if directory is not a directory.
- Return type
-
abstract classmethod
in_repo
(directory)[source]¶ Is directory inside of the VCS repository?
- Raises
NotADirectoryError – if directory is not a directory.
- Return type
-
abstract classmethod
-
class
reuse.vcs.
VCSStrategyGit
(project)[source]¶ Bases:
reuse.vcs.VCSStrategy
Strategy that is used for Git.
-
classmethod
find_root
(cwd=None)[source]¶ Try to find the root of the project from cwd. If none is found, return None.
- Raises
NotADirectoryError – if directory is not a directory.
- Return type
-
classmethod
in_repo
(directory)[source]¶ Is directory inside of the VCS repository?
- Raises
NotADirectoryError – if directory is not a directory.
- Return type
-
classmethod
-
class
reuse.vcs.
VCSStrategyHg
(project)[source]¶ Bases:
reuse.vcs.VCSStrategy
Strategy that is used for Mercurial.
-
classmethod
find_root
(cwd=None)[source]¶ Try to find the root of the project from cwd. If none is found, return None.
- Raises
NotADirectoryError – if directory is not a directory.
- Return type
-
classmethod
in_repo
(directory)[source]¶ Is directory inside of the VCS repository?
- Raises
NotADirectoryError – if directory is not a directory.
- Return type
-
classmethod
-
class
reuse.vcs.
VCSStrategyNone
(project)[source]¶ Bases:
reuse.vcs.VCSStrategy
Strategy that is used when there is no VCS.
-
classmethod
find_root
(cwd=None)[source]¶ Try to find the root of the project from cwd. If none is found, return None.
- Raises
NotADirectoryError – if directory is not a directory.
- Return type
-
classmethod
in_repo
(directory)[source]¶ Is directory inside of the VCS repository?
- Raises
NotADirectoryError – if directory is not a directory.
- Return type
-
classmethod
-
reuse.vcs.
find_root
(cwd=None)[source]¶ Try to find the root of the project from cwd. If none is found, return None.
- Raises
NotADirectoryError – if directory is not a directory.
- Return type