1VCSTOOLS(1) vcstools VCSTOOLS(1)
2
6 vcstools - vcstools Documentation
7 The vcstools module provides a Python API for interacting with differ‐
9 ent version control systems (VCS/SCMs). The VcsClient class provides
10 an API for seamless interacting with Git, Mercurial (Hg), Bzr and SVN.
11 The focus of the API is manipulating on-disk checkouts of source-con‐
12 trolled trees. Its main use is to support the rosinstall tool.
13
15 The VcsClient class provides a generic API for
16 · Subversion (svn)
18 · Mercurial (hg)
20 · Git (git)
22 · Bazaar (bzr)
24 class vcstools.VcsClient(vcs_type, path)
26 API for interacting with source-controlled paths independent of
27 actual version-control implementation.
28 Parameters
30 · vcs_type – type of VCS to use (e.g. ‘svn’, ‘hg’, ‘bzr’,
32 ‘git’), str
33 · path – filesystem path where code is/will be checked
35 out , str
36 path_exists() -> bool
38 Returns
40 True if path exists on disk.
41 get_path() -> str
43 Returns
45 filesystem path this client is initialized with.
46 url_matches(self, url, url_or_shortcut) -> bool
48 client can decide whether the url and the other url are
49 equivalent. Checks string equality by default
50 Parameters
52 url_or_shortcut – url or shortcut (e.g. bzr
53 launchpad url)
54 Returns
56 bool if params are equivalent
57 get_version([spec=None]) -> str
59 Parameters
61 spec –
62 token for identifying repository revision desired.
64 Token might be a tagname, branchname, version-id,
65 or SHA-ID depending on the VCS implementation.
66 · svn: anything accepted by svn info --help, e.g.
68 a revnumber, {date}, HEAD, BASE, PREV, or COM‐
69 MITTED
70 · git: anything accepted by git log, e.g. a tag‐
72 name, branchname, or sha-id.
73 · hg: anything accepted by hg log -r, e.g. a tag‐
75 name, sha-ID, revision-number
76 · bzr: revisionspec as returned by bzr help revi‐
78 sionspec, e.g. a tagname or revno:<number>
79 Returns
82 current revision number of the repository. Or if
83 spec is provided, the globally unique identifier
84 (e.g. revision number, or SHA-ID) of a revision
85 specified by some token.
86 get_remote_version(self, fatch=False) -> str
88 Find an identifier for the current revision on remote.
89 Token spec might be a tagname, version-id, SHA-ID, …
90 depending on the VCS implementation.
91 Parameters
93 fetch – if False, only local information may be
94 used
95 Returns
97 current revision number of the remote repository.
98 get_current_version_label() -> str
100 Find an description for the current local version. Token
101 spec might be a branchname, version-id, SHA-ID, … depend‐
102 ing on the VCS implementation.
103 returns
105 short description of local version (e.g.
106 branchname, tagename).
107 checkout(url[, version=''][, verbose=False][, shallow=False])
109 Checkout the given URL to the path associated with this
110 client.
111 Parameters
113 · url – URL of source control to check out
115 · version – specific version to check out
117 · verbose – flag to run verbosely
119 · shallow – flag to create shallow clone without
121 history
122 update(version)
124 Update the local checkout from upstream source control.
125 detect_presence() -> bool
127 Returns
129 True if path has a checkout with matching VCS
130 type, e.g. if the type of this client is ‘svn’,
131 the checkout at the path is managed by Subversion.
132 get_vcs_type_name() -> str
134 Returns
136 type of VCS this client is initialized with.
137 get_url() -> str
139 Returns
141 Upstream URL that this code was checked out from.
142 get_branch_parent()
144 (Git Only)
145 Returns
147 parent branch.
148 get_diff([basepath=None])
150 Parameters
152 basepath – compute diff relative to this path, if
153 provided
154 Returns
156 A string showing local differences
157 get_status([basepath=None[, untracked=False]])
159 Calls scm status command. semantics of untracked are dif‐
160 ficult to generalize. In SVN, this would be new files
161 only. In git, hg, bzr, this would be changes that have
162 not been added for commit.
163 Parameters
165 · basepath – status path will be relative to this,
167 if provided.
168 · untracked – If True, also show changes that
170 would not commit
171 Returns
173 A string summarizing locally modified files
174 Example:
176 import vcstools
178 # interrogate an existing tree
180 client = vcstools.VcsClient('svn', '/path/to/checkout')
181 print client.get_url()
183 print client.get_version()
184 print client.get_diff()
185 # create a new tree
187 client = vcstools.VcsClient('hg', '/path/to/new/checkout')
188 client.checkout('https://bitbucket.org/foo/bar')
189 vcstools is available on pypi and can be installed via pip
191 pip install vcstools
193 or easy_install:
195 easy_install vcstools
197 The vcstools module is meant to be used as a normal Python module.
199 After it has been installed, you can import it normally and do not need
200 to declare as a ROS package dependency.
201
203 Code API
204 Packages
205 vcstools Package
206 vcstools Package
207 Library for tools that need to interact with ROS-support version con‐
208 trol systems.
209 vcstools.setup_logger()
211 creates a logger 'vcstools'
212 bzr Module
214 bzr vcs support.
215 vcstools.bzr.BZRClient
217 alias of vcstools.bzr.BzrClient
218 class vcstools.bzr.BzrClient(path)
220 Bases: vcstools.vcs_base.VcsClientBase
221 __init__(path)
223 Raises VcsError if bzr not detected
225 checkout(url, version=None, verbose=False, shallow=False, time‐
227 out=None)
228 Attempts to create a local repository given a remote url.
229 Fails if a target path exists, unless it's an empty
230 directory. If a version is provided, the local reposi‐
231 tory will be updated to that revision. It is possible
232 that after a failed call to checkout, a repository still
233 exists, e.g. if an invalid revision was given. If shal‐
234 low is provided, the scm client may checkout less than
235 the full repository history to save time / disk space.
236 If a timeout is specified, any pending operation will
237 fail after the specified amount (in seconds). NOTE: this
238 parameter might or might not be honored, depending on VCS
239 client implementation. :param url: where to checkout
240 from :type url: str :param version: token for identifying
241 repository revision :type version: str :param shallow:
242 hint to checkout less than a full repository :type shal‐
243 low: bool :param timeout: maximum allocated time to per‐
244 form operation :type shallow: int :returns: True if suc‐
245 cessful
246 export_repository(version, basepath)
248 Calls scm equivalent to svn export, removing scm meta
249 information and tar gzip'ing the repository at a given
250 version to the given basepath.
251 Parameters
253 version -- version of the repository to export.
254 This can
255 be a branch, tag, or path (svn). When specifying the
257 version as a path for svn, the path should be relative to
258 the root of the svn repository, i.e. 'trunk', or
259 'tags/1.2.3', or './' for the root. :param basepath:
260 this is the path to the tar gzip, excluding the extension
261 which will be .tar.gz :returns: True on success, False
262 otherwise.
263 get_affected_files(revision)
265 Get the files that were affected by a specific revision
266 :param revision: SHA or revision number. :returns: A
267 list of strings with the files affected by a specific
268 commit
269 get_branches(local_only=False)
271 Returns a list of all branches in the vcs repository.
272 Parameters
274 local_only -- if True it will only list local
275 branches
276 Returns
278 list of branches in the repository, [] if none
279 exist
280 get_current_version_label()
282 Find an description for the current local version. Token
283 spec might be a branchname, version-id, SHA-ID, ...
284 depending on the VCS implementation.
285 Returns
287 short description of local version (e.g. branch‐
288 name, tagename).
289 Return type
291 str
292 get_diff(basepath=None)
294 Parameters
296 basepath -- diff paths will be relative to this,
297 if any
298 Returns
300 A string showing local differences
301 Return type
303 str
304 static get_environment_metadata()
306 For debugging purposes, returns a dict containing infor‐
307 mation about the environment, like the version of the SCM
308 client, or version of libraries involved. Suggest con‐
309 sidering keywords "version", "dependency", "features"
310 first. :returns: a dict containing relevant information
311 :rtype: dict
312 get_log(relpath=None, limit=None)
314 Calls scm log command.
315 This returns a list of dictionaries with the following
317 fields:
318 · id: the commit SHA or revision number
320 · date: the date the commit was made (python date‐
322 time)
323 · author: the name of the author of the commit, if
325 available
326 · email: the e-mail address of the author of the
328 commit
329 · message: the commit message, if any
331 Parameters
333 relpath -- (optional) restrict logs to events on
334 this
335 resource path (folder or file) relative to the root of
337 the repository. If None (default), this is the root of
338 the repository. :param limit: (optional) the maximum
339 number of log entries that should be retrieved. If None
340 (default), there is no limit.
341 get_remote_version(fetch=False)
343 Find an identifier for the current revision on remote.
344 Token spec might be a tagname, version-id, SHA-ID, ...
345 depending on the VCS implementation.
346 Parameters
348 fetch -- if False, only local information may be
349 used
350 Returns
352 current revision number of the remote repository.
353 Return type
355 str
356 get_status(basepath=None, untracked=False)
358 Calls scm status command. Output must be terminated by
359 newline unless empty.
360 Semantics of untracked are difficult to generalize. In
362 SVN, this would be new files only. In git, hg, bzr, this
363 would be changes that have not been added for commit.
364 Extra keyword arguments are passed along to the underly‐
366 ing vcs code. See the specific implementations of
367 get_status() for extra options.
368 Parameters
370 · basepath -- status path will be relative to
372 this, if any
373 · untracked -- whether to also show changes that
375 would not commit
376 Returns
378 A string summarizing locally modified files
379 Return type
381 str
382 get_url()
384 Returns
386 BZR URL of the branch (output of bzr info com‐
387 mand),
388 or None if it cannot be determined
390 get_version(spec=None)
392 Parameters
394 spec -- (optional) revisionspec of desired ver‐
395 sion. May be any revisionspec as returned by 'bzr
396 help revisionspec', e.g. a tagname or 'revno:<num‐
397 ber>'
398 Returns
400 the current revision number of the repository. Or
401 if spec is provided, the number of a revision
402 specified by some token.
403 static static_detect_presence(path)
405 For auto detection
406 update(version='', verbose=False, timeout=None)
408 Sets the local copy of the repository to a version match‐
409 ing the version parameter. Fails when there are uncom‐
410 mited changes. On failures (also e.g. network failure)
411 grants the checked out files are in the same state as
412 before the call. If a timeout is specified, any pending
413 operation will fail after the specified amount (in sec‐
414 onds)
415 Parameters
417 · version -- token for identifying repository
419 revision desired. Token might be a tagname,
420 branchname, version-id, SHA-ID, ... depending on
421 the VCS implementation.
422 · timeout -- maximum allocated time to perform
424 operation
425 Returns
427 True on success, False else
428 url_matches(url, url_or_shortcut)
430 client can decide whether the url and the other url are
431 equivalent. Checks string equality by default :param
432 url_or_shortcut: url or shortcut (e.g. bzr launchpad url)
433 :returns: bool if params are equivalent
434 vcstools.bzr._get_bzr_version()
436 Looks up bzr version by calling bzr --version. :raises: VcsEr‐
437 ror if bzr is not installed
438 git Module
440 git vcs support.
441 refnames in git can be branchnames, hashes, partial hashes, tags. On
443 checkout, git will disambiguate by checking them in that order, taking
444 the first that applies
445 This class aims to provide git for linear centralized workflows. This
447 means in case of ambiguity, we assume that the only relevant remote is
448 the one named "origin", and we assume that commits once on origin
449 remain on origin.
450 A challenge with git is that it has strong reasonable conventions, but
452 is very allowing for breaking them. E.g. it is possible to name remotes
453 and branches with names like "refs/heads/master", give branches and
454 tags the same name, or a valid SHA-ID as name, etc. Similarly git
455 allows plenty of ways to reference any object, in case of ambiguities,
456 git attempts to take the most reasonable disambiguation, and in some
457 cases warns.
458 vcstools.git.GITClient
460 alias of vcstools.git.GitClient
461 class vcstools.git.GitClient(path)
463 Bases: vcstools.vcs_base.VcsClientBase
464 __init__(path)
466 Raises VcsError if git not detected
468 _do_checkout(refname, fetch=True, verbose=False)
470 meaning git checkout, not vcstools checkout. This works
471 for local branches, remote branches, tagnames, hashes,
472 etc. git will create local branch of same name when no
473 such local branch exists, and also setup tracking. Git
474 decides with own rules whether local changes would cause
475 conflicts, and refuses to checkout else.
476 Raises GitError -- when checkout fails
478 _do_fast_forward(branch_parent, fetch=True, verbose=False)
480 Execute git fetch if necessary, and if we can
481 fast-foward, do so to the last fetched version using git
482 rebase.
483 Parameters
485 · branch_parent -- name of branch we track
487 · fetch -- whether fetch should be done first for
489 remote refs
490 Returns
492 True if up-to-date or after succesful fast-forward
493 Raises GitError when git fetch fails
495 _do_fetch(timeout=None)
497 calls git fetch :raises: GitError when call fails
498 _do_update(refname=None, verbose=False, fast_foward=True, time‐
500 out=None, update_submodules=True)
501 updates without fetching, thus any necessary fetching
502 must be done before allows arguments to reduce unneces‐
503 sary steps after checkout
504 Parameters
506 · fast_foward -- if false, does not perform
508 fast-forward
509 · update_submodules -- if false, does not attempt
511 to update submodules
512 _get_branch()
514 _get_branch_parent(fetch=False, current_branch=None)
516 Parameters
518 · fetch -- if true, performs git fetch first
520 · current_branch -- if not None, this is used as
522 current branch (else extra shell call)
523 Returns
525 (branch, remote) the name of the branch this
526 branch tracks and its remote
527 Raises GitError if fetch fails
529 _get_default_remote()
531 in order to support users who name their default origin
532 something else than origin, read remote name.
533 _is_commit_in_orphaned_subtree(version, mask_self=False,
535 fetch=True)
536 checks git log --all (the list of all commits reached by
537 references, meaning branches or tags) for version. If it
538 shows up, that means git garbage collection will not
539 remove the commit. Else it would eventually be deleted.
540 Parameters
542 · version -- SHA IDs (if partial, caller is
544 responsible for mismatch)
545 · mask_self -- whether to consider direct refer‐
547 ences to this commit (rather than only refer‐
548 ences on descendants) as well
549 · fetch -- whether fetch should be done first for
551 remote refs
552 Returns
554 True if version is not recursively referenced by a
555 branch or tag
556 Raises GitError if git fetch fails
558 _is_local_branch(branch_name)
560 _is_remote_branch(branch_name, remote_name=None, fetch=True)
562 checks list of remote branches for match. Set fetch to
563 False if you just fetched already.
564 Returns
566 True if branch_name exists for remote
567 <remote_name> (or 'origin' if None)
568 Raises GitError when git fetch fails
570 _rev_list_contains(refname, version, fetch=True)
572 calls git rev-list with refname and returns True if ver‐
573 sion can be found in rev-list result
574 Parameters
576 · refname -- a git refname
578 · version -- an SHA IDs (if partial, caller is
580 responsible for mismatch)
581 Returns
583 True if version is an ancestor commit from refname
584 Raises GitError when call to git fetch fails
586 _update_submodules(verbose=False, timeout=None)
588 checkout(url, version=None, verbose=False, shallow=False, time‐
590 out=None)
591 calls git clone and then, if version was given,
592 update(version)
593 export_repository(version, basepath)
595 Calls scm equivalent to svn export, removing scm meta
596 information and tar gzip'ing the repository at a given
597 version to the given basepath.
598 Parameters
600 version -- version of the repository to export.
601 This can
602 be a branch, tag, or path (svn). When specifying the
604 version as a path for svn, the path should be relative to
605 the root of the svn repository, i.e. 'trunk', or
606 'tags/1.2.3', or './' for the root. :param basepath:
607 this is the path to the tar gzip, excluding the extension
608 which will be .tar.gz :returns: True on success, False
609 otherwise.
610 get_affected_files(revision)
612 Get the files that were affected by a specific revision
613 :param revision: SHA or revision number. :returns: A
614 list of strings with the files affected by a specific
615 commit
616 get_branches(local_only=False)
618 Returns a list of all branches in the vcs repository.
619 Parameters
621 local_only -- if True it will only list local
622 branches
623 Returns
625 list of branches in the repository, [] if none
626 exist
627 get_current_version_label()
629 For git we change the label to clarify when a different
630 remote is configured.
631 get_default_remote_version_label()
633 Find a label for the default branch on remote, meaning
634 the one that would be checked out on a clean checkout.
635 Returns
637 a label or None (if not applicable)
638 Return type
640 str
641 get_diff(basepath=None)
643 Parameters
645 basepath -- diff paths will be relative to this,
646 if any
647 Returns
649 A string showing local differences
650 Return type
652 str
653 static get_environment_metadata()
655 For debugging purposes, returns a dict containing infor‐
656 mation about the environment, like the version of the SCM
657 client, or version of libraries involved. Suggest con‐
658 sidering keywords "version", "dependency", "features"
659 first. :returns: a dict containing relevant information
660 :rtype: dict
661 get_log(relpath=None, limit=None)
663 Calls scm log command.
664 This returns a list of dictionaries with the following
666 fields:
667 · id: the commit SHA or revision number
669 · date: the date the commit was made (python date‐
671 time)
672 · author: the name of the author of the commit, if
674 available
675 · email: the e-mail address of the author of the
677 commit
678 · message: the commit message, if any
680 Parameters
682 relpath -- (optional) restrict logs to events on
683 this
684 resource path (folder or file) relative to the root of
686 the repository. If None (default), this is the root of
687 the repository. :param limit: (optional) the maximum
688 number of log entries that should be retrieved. If None
689 (default), there is no limit.
690 get_remote_version(fetch=False)
692 Find an identifier for the current revision on remote.
693 Token spec might be a tagname, version-id, SHA-ID, ...
694 depending on the VCS implementation.
695 Parameters
697 fetch -- if False, only local information may be
698 used
699 Returns
701 current revision number of the remote repository.
702 Return type
704 str
705 get_status(basepath=None, untracked=False, porcelain=False)
707 Calls scm status command. Output must be terminated by
708 newline unless empty.
709 Semantics of untracked are difficult to generalize. In
711 SVN, this would be new files only. In git, hg, bzr, this
712 would be changes that have not been added for commit.
713 Extra keyword arguments are passed along to the underly‐
715 ing vcs code. See the specific implementations of
716 get_status() for extra options.
717 Parameters
719 · basepath -- status path will be relative to
721 this, if any
722 · untracked -- whether to also show changes that
724 would not commit
725 Returns
727 A string summarizing locally modified files
728 Return type
730 str
731 get_url()
733 Returns
735 git URL of the directory path (output of git info
736 command), or None if it cannot be determined
737 get_version(spec=None)
739 Parameters
741 · spec -- (optional) token to identify desired
743 version. For git, this may be anything accepted
744 by git log, e.g. a tagname, branchname, or
745 sha-id.
746 · fetch -- When spec is given, can be used to sup‐
748 press git fetch call
749 Returns
751 current SHA-ID of the repository. Or if spec is
752 provided, the SHA-ID of a commit specified by some
753 token if found, else None
754 is_tag(tag_name, fetch=True)
756 checks list of tags for match. Set fetch to False if you
757 just fetched already.
758 Returns
760 True if tag_name among known tags
761 Raises GitError when call to git fetch fails
763 static static_detect_presence(path)
765 For auto detection
766 update(version=None, verbose=False, force_fetch=False, time‐
768 out=None)
769 if version is None, attempts fast-forwarding current
770 branch, if any.
771 Else interprets version as a local branch, remote branch,
773 tagname, hash, etc.
774 If it is a branch, attempts to move to it unless already
776 on it, and to fast-forward, unless not a tracking branch.
777 Else go untracked on tag or whatever version is. Does not
778 leave if current commit would become dangling.
779 Returns
781 True if already up-to-date with remote or after
782 successful fast_foward
783 exception vcstools.git.GitError
785 Bases: Exception
786 vcstools.git._get_git_version()
788 Looks up git version by calling git --version.
789 Raises VcsError if git is not installed or returns
791 something unexpected
793 vcstools.git._git_diff_path_submodule_change(diff, rel_path_prefix)
795 Parses git diff result and changes the filename prefixes.
796 hg Module
798 hg vcs support.
799 using ui object to redirect output into a string
801 vcstools.hg.HGClient
803 alias of vcstools.hg.HgClient
804 class vcstools.hg.HgClient(path)
806 Bases: vcstools.vcs_base.VcsClientBase
807 __init__(path)
809 Raises VcsError if hg not detected
811 _do_pull(filter=False)
813 checkout(url, version='', verbose=False, shallow=False, time‐
815 out=None)
816 Attempts to create a local repository given a remote url.
817 Fails if a target path exists, unless it's an empty
818 directory. If a version is provided, the local reposi‐
819 tory will be updated to that revision. It is possible
820 that after a failed call to checkout, a repository still
821 exists, e.g. if an invalid revision was given. If shal‐
822 low is provided, the scm client may checkout less than
823 the full repository history to save time / disk space.
824 If a timeout is specified, any pending operation will
825 fail after the specified amount (in seconds). NOTE: this
826 parameter might or might not be honored, depending on VCS
827 client implementation. :param url: where to checkout
828 from :type url: str :param version: token for identifying
829 repository revision :type version: str :param shallow:
830 hint to checkout less than a full repository :type shal‐
831 low: bool :param timeout: maximum allocated time to per‐
832 form operation :type shallow: int :returns: True if suc‐
833 cessful
834 export_repository(version, basepath)
836 Calls scm equivalent to svn export, removing scm meta
837 information and tar gzip'ing the repository at a given
838 version to the given basepath.
839 Parameters
841 version -- version of the repository to export.
842 This can
843 be a branch, tag, or path (svn). When specifying the
845 version as a path for svn, the path should be relative to
846 the root of the svn repository, i.e. 'trunk', or
847 'tags/1.2.3', or './' for the root. :param basepath:
848 this is the path to the tar gzip, excluding the extension
849 which will be .tar.gz :returns: True on success, False
850 otherwise.
851 get_affected_files(revision)
853 Get the files that were affected by a specific revision
854 :param revision: SHA or revision number. :returns: A
855 list of strings with the files affected by a specific
856 commit
857 get_branch()
859 get_branches(local_only=False)
861 Returns a list of all branches in the vcs repository.
862 Parameters
864 local_only -- if True it will only list local
865 branches
866 Returns
868 list of branches in the repository, [] if none
869 exist
870 get_current_version_label()
872 Parameters
874 spec -- (optional) spec can be what 'svn info
875 --help' allows, meaning a revnumber, {date}, HEAD,
876 BASE, PREV, or COMMITTED.
877 Returns
879 current revision number of the repository. Or if
880 spec provided, the number of a revision specified
881 by some token.
882 get_diff(basepath=None)
884 Parameters
886 basepath -- diff paths will be relative to this,
887 if any
888 Returns
890 A string showing local differences
891 Return type
893 str
894 static get_environment_metadata()
896 For debugging purposes, returns a dict containing infor‐
897 mation about the environment, like the version of the SCM
898 client, or version of libraries involved. Suggest con‐
899 sidering keywords "version", "dependency", "features"
900 first. :returns: a dict containing relevant information
901 :rtype: dict
902 get_log(relpath=None, limit=None)
904 Calls scm log command.
905 This returns a list of dictionaries with the following
907 fields:
908 · id: the commit SHA or revision number
910 · date: the date the commit was made (python date‐
912 time)
913 · author: the name of the author of the commit, if
915 available
916 · email: the e-mail address of the author of the
918 commit
919 · message: the commit message, if any
921 Parameters
923 relpath -- (optional) restrict logs to events on
924 this
925 resource path (folder or file) relative to the root of
927 the repository. If None (default), this is the root of
928 the repository. :param limit: (optional) the maximum
929 number of log entries that should be retrieved. If None
930 (default), there is no limit.
931 get_remote_version(fetch=False)
933 Find an identifier for the current revision on remote.
934 Token spec might be a tagname, version-id, SHA-ID, ...
935 depending on the VCS implementation.
936 Parameters
938 fetch -- if False, only local information may be
939 used
940 Returns
942 current revision number of the remote repository.
943 Return type
945 str
946 get_status(basepath=None, untracked=False)
948 Calls scm status command. Output must be terminated by
949 newline unless empty.
950 Semantics of untracked are difficult to generalize. In
952 SVN, this would be new files only. In git, hg, bzr, this
953 would be changes that have not been added for commit.
954 Extra keyword arguments are passed along to the underly‐
956 ing vcs code. See the specific implementations of
957 get_status() for extra options.
958 Parameters
960 · basepath -- status path will be relative to
962 this, if any
963 · untracked -- whether to also show changes that
965 would not commit
966 Returns
968 A string summarizing locally modified files
969 Return type
971 str
972 get_url()
974 Returns
976 HG URL of the directory path. (output of hg paths
977 command), or None if it cannot be determined
979 get_version(spec=None)
981 Parameters
983 spec -- (optional) token for identifying version.
984 spec can be a whatever is allowed by 'hg log -r',
985 e.g. a tagname, sha-ID, revision-number
986 Returns
988 the current SHA-ID of the repository. Or if spec
989 is provided, the SHA-ID of a revision specified by
990 some token.
991 static static_detect_presence(path)
993 For auto detection
994 update(version='', verbose=False, timeout=None)
996 Sets the local copy of the repository to a version match‐
997 ing the version parameter. Fails when there are uncom‐
998 mited changes. On failures (also e.g. network failure)
999 grants the checked out files are in the same state as
1000 before the call. If a timeout is specified, any pending
1001 operation will fail after the specified amount (in sec‐
1002 onds)
1003 Parameters
1005 · version -- token for identifying repository
1007 revision desired. Token might be a tagname,
1008 branchname, version-id, SHA-ID, ... depending on
1009 the VCS implementation.
1010 · timeout -- maximum allocated time to perform
1012 operation
1013 Returns
1015 True on success, False else
1016 vcstools.hg._get_hg_version()
1018 Looks up hg version by calling hg --version. :raises: VcsError
1019 if hg is not installed
1020 vcstools.hg._hg_diff_path_change(diff, path)
1022 Parses hg diff result and changes the filename prefixes.
1023 svn Module
1025 svn vcs support.
1026 vcstools.svn.SVNClient
1028 alias of vcstools.svn.SvnClient
1029 class vcstools.svn.SvnClient(path)
1031 Bases: vcstools.vcs_base.VcsClientBase
1032 __init__(path)
1034 Raises VcsError if python-svn not detected
1036 _get_version_from_path(spec=None, path=None)
1038 Parameters
1040 · spec -- (optional) spec can be what 'svn info
1042 --help' allows, meaning a revnumber, {date},
1043 HEAD, BASE, PREV, or COMMITTED.
1044 · path -- the url to use, default is for this repo
1046 Returns
1048 current revision number of the repository. Or if
1049 spec provided, the number of a revision specified
1050 by some token.
1051 checkout(url, version='', verbose=False, shallow=False, time‐
1053 out=None)
1054 Attempts to create a local repository given a remote url.
1055 Fails if a target path exists, unless it's an empty
1056 directory. If a version is provided, the local reposi‐
1057 tory will be updated to that revision. It is possible
1058 that after a failed call to checkout, a repository still
1059 exists, e.g. if an invalid revision was given. If shal‐
1060 low is provided, the scm client may checkout less than
1061 the full repository history to save time / disk space.
1062 If a timeout is specified, any pending operation will
1063 fail after the specified amount (in seconds). NOTE: this
1064 parameter might or might not be honored, depending on VCS
1065 client implementation. :param url: where to checkout
1066 from :type url: str :param version: token for identifying
1067 repository revision :type version: str :param shallow:
1068 hint to checkout less than a full repository :type shal‐
1069 low: bool :param timeout: maximum allocated time to per‐
1070 form operation :type shallow: int :returns: True if suc‐
1071 cessful
1072 export_repository(version, basepath)
1074 Calls scm equivalent to svn export, removing scm meta
1075 information and tar gzip'ing the repository at a given
1076 version to the given basepath.
1077 Parameters
1079 version -- version of the repository to export.
1080 This can
1081 be a branch, tag, or path (svn). When specifying the
1083 version as a path for svn, the path should be relative to
1084 the root of the svn repository, i.e. 'trunk', or
1085 'tags/1.2.3', or './' for the root. :param basepath:
1086 this is the path to the tar gzip, excluding the extension
1087 which will be .tar.gz :returns: True on success, False
1088 otherwise.
1089 get_affected_files(revision)
1091 Get the files that were affected by a specific revision
1092 :param revision: SHA or revision number. :returns: A
1093 list of strings with the files affected by a specific
1094 commit
1095 get_branches(local_only=False)
1097 Returns a list of all branches in the vcs repository.
1098 Parameters
1100 local_only -- if True it will only list local
1101 branches
1102 Returns
1104 list of branches in the repository, [] if none
1105 exist
1106 get_current_version_label()
1108 Find an description for the current local version. Token
1109 spec might be a branchname, version-id, SHA-ID, ...
1110 depending on the VCS implementation.
1111 Returns
1113 short description of local version (e.g. branch‐
1114 name, tagename).
1115 Return type
1117 str
1118 get_diff(basepath=None)
1120 Parameters
1122 basepath -- diff paths will be relative to this,
1123 if any
1124 Returns
1126 A string showing local differences
1127 Return type
1129 str
1130 static get_environment_metadata()
1132 For debugging purposes, returns a dict containing infor‐
1133 mation about the environment, like the version of the SCM
1134 client, or version of libraries involved. Suggest con‐
1135 sidering keywords "version", "dependency", "features"
1136 first. :returns: a dict containing relevant information
1137 :rtype: dict
1138 get_log(relpath=None, limit=None)
1140 Calls scm log command.
1141 This returns a list of dictionaries with the following
1143 fields:
1144 · id: the commit SHA or revision number
1146 · date: the date the commit was made (python date‐
1148 time)
1149 · author: the name of the author of the commit, if
1151 available
1152 · email: the e-mail address of the author of the
1154 commit
1155 · message: the commit message, if any
1157 Parameters
1159 relpath -- (optional) restrict logs to events on
1160 this
1161 resource path (folder or file) relative to the root of
1163 the repository. If None (default), this is the root of
1164 the repository. :param limit: (optional) the maximum
1165 number of log entries that should be retrieved. If None
1166 (default), there is no limit.
1167 get_remote_version(fetch=False)
1169 Find an identifier for the current revision on remote.
1170 Token spec might be a tagname, version-id, SHA-ID, ...
1171 depending on the VCS implementation.
1172 Parameters
1174 fetch -- if False, only local information may be
1175 used
1176 Returns
1178 current revision number of the remote repository.
1179 Return type
1181 str
1182 get_status(basepath=None, untracked=False)
1184 Calls scm status command. Output must be terminated by
1185 newline unless empty.
1186 Semantics of untracked are difficult to generalize. In
1188 SVN, this would be new files only. In git, hg, bzr, this
1189 would be changes that have not been added for commit.
1190 Extra keyword arguments are passed along to the underly‐
1192 ing vcs code. See the specific implementations of
1193 get_status() for extra options.
1194 Parameters
1196 · basepath -- status path will be relative to
1198 this, if any
1199 · untracked -- whether to also show changes that
1201 would not commit
1202 Returns
1204 A string summarizing locally modified files
1205 Return type
1207 str
1208 get_url()
1210 Returns
1212 SVN URL of the directory path (output of svn info
1213 command), or None if it cannot be determined
1214 get_version(spec=None)
1216 Parameters
1218 · spec -- (optional) spec can be what 'svn info
1220 --help' allows, meaning a revnumber, {date},
1221 HEAD, BASE, PREV, or COMMITTED.
1222 · path -- the url to use, default is for this repo
1224 Returns
1226 current revision number of the repository. Or if
1227 spec provided, the number of a revision specified
1228 by some token.
1229 static static_detect_presence(path)
1231 For auto detection
1232 update(version=None, verbose=False, timeout=None)
1234 Sets the local copy of the repository to a version match‐
1235 ing the version parameter. Fails when there are uncom‐
1236 mited changes. On failures (also e.g. network failure)
1237 grants the checked out files are in the same state as
1238 before the call. If a timeout is specified, any pending
1239 operation will fail after the specified amount (in sec‐
1240 onds)
1241 Parameters
1243 · version -- token for identifying repository
1245 revision desired. Token might be a tagname,
1246 branchname, version-id, SHA-ID, ... depending on
1247 the VCS implementation.
1248 · timeout -- maximum allocated time to perform
1250 operation
1251 Returns
1253 True on success, False else
1254 vcstools.svn._get_svn_version()
1256 Looks up svn version by calling svn --version. :raises: VcsEr‐
1257 ror if svn is not installed
1258 vcstools.svn.canonical_svn_url_split(url)
1260 checks url for traces of canonical svn structure, and return
1261 root, type, name (of tag or branch), subfolder, query and frag‐
1262 ment (see urllib urlparse) This should allow creating a differ‐
1263 ent url for switching to a different tag or branch
1264 Parameters
1266 url -- location of central repo, str
1267 Returns
1269 dict {root, type, name, subfolder, query, fragment}
1270 with type one of "trunk", "tags", "branches"
1272 vcstools.svn.get_remote_contents(url)
1274 tar Module
1276 tar vcs support.
1277 The implementation uses the "version" argument to indicate a subfolder
1279 within a tarfile. Hence one can organize sources by creating one
1280 tarfile with a folder inside for each version.
1281 vcstools.tar.TARClient
1283 alias of vcstools.tar.TarClient
1284 class vcstools.tar.TarClient(path)
1286 Bases: vcstools.vcs_base.VcsClientBase
1287 __init__(path)
1289 @raise VcsError if tar not detected
1290 checkout(url, version='', verbose=False, shallow=False, time‐
1292 out=None)
1293 untars tar at url to self.path. If version was given,
1294 only the subdirectory 'version' of the tar will end up in
1295 self.path. Also creates a file next to the checkout
1296 named
1297 *
1298 .tar which is a yaml file listing origin url and version
1299 arguments.
1300 export_repository(version, basepath)
1302 Calls scm equivalent to svn export, removing scm meta
1303 information and tar gzip'ing the repository at a given
1304 version to the given basepath.
1305 Parameters
1307 version -- version of the repository to export.
1308 This can
1309 be a branch, tag, or path (svn). When specifying the
1311 version as a path for svn, the path should be relative to
1312 the root of the svn repository, i.e. 'trunk', or
1313 'tags/1.2.3', or './' for the root. :param basepath:
1314 this is the path to the tar gzip, excluding the extension
1315 which will be .tar.gz :returns: True on success, False
1316 otherwise.
1317 get_current_version_label()
1319 Find an description for the current local version. Token
1320 spec might be a branchname, version-id, SHA-ID, ...
1321 depending on the VCS implementation.
1322 Returns
1324 short description of local version (e.g. branch‐
1325 name, tagename).
1326 Return type
1328 str
1329 get_diff(basepath=None)
1331 Parameters
1333 basepath -- diff paths will be relative to this,
1334 if any
1335 Returns
1337 A string showing local differences
1338 Return type
1340 str
1341 static get_environment_metadata()
1343 For debugging purposes, returns a dict containing infor‐
1344 mation about the environment, like the version of the SCM
1345 client, or version of libraries involved. Suggest con‐
1346 sidering keywords "version", "dependency", "features"
1347 first. :returns: a dict containing relevant information
1348 :rtype: dict
1349 get_remote_version(fetch=False)
1351 Find an identifier for the current revision on remote.
1352 Token spec might be a tagname, version-id, SHA-ID, ...
1353 depending on the VCS implementation.
1354 Parameters
1356 fetch -- if False, only local information may be
1357 used
1358 Returns
1360 current revision number of the remote repository.
1361 Return type
1363 str
1364 get_status(basepath=None, untracked=False)
1366 Calls scm status command. Output must be terminated by
1367 newline unless empty.
1368 Semantics of untracked are difficult to generalize. In
1370 SVN, this would be new files only. In git, hg, bzr, this
1371 would be changes that have not been added for commit.
1372 Extra keyword arguments are passed along to the underly‐
1374 ing vcs code. See the specific implementations of
1375 get_status() for extra options.
1376 Parameters
1378 · basepath -- status path will be relative to
1380 this, if any
1381 · untracked -- whether to also show changes that
1383 would not commit
1384 Returns
1386 A string summarizing locally modified files
1387 Return type
1389 str
1390 get_url()
1392 Returns
1394 TAR URL of the directory path (output of tar info
1395 command), or None if it cannot be determined
1397 get_version(spec=None)
1399 Find an identifier for a the current or a specified revi‐
1400 sion. Token spec might be a tagname, branchname, ver‐
1401 sion-id, SHA-ID, ... depending on the VCS implementation.
1402 Parameters
1404 spec (str) -- token for identifying repository
1405 revision
1406 Returns
1408 current revision number of the repository. Or if
1409 spec is provided, the respective revision number.
1410 Return type
1412 str
1413 static static_detect_presence(path)
1415 For auto detection
1416 update(version='', verbose=False, timeout=None)
1418 Does nothing except returning true if tar exists in same
1419 "version" as checked out with vcstools.
1420 vcs_abstraction Module
1422 undoc-members
1423 show-inheritance
1425 vcstools.vcs_abstraction.VCSClient
1427 alias of vcstools.vcs_abstraction.VcsClient
1428 class vcstools.vcs_abstraction.VcsClient(vcs_type, path)
1430 Bases: object
1431 DEPRECATED API for interacting with source-controlled paths
1433 independent of actual version-control implementation.
1434 __init__(vcs_type, path)
1436 Initialize self. See help(type(self)) for accurate sig‐
1437 nature.
1438 vcstools.vcs_abstraction.get_registered_vcs_types()
1440 Returns
1442 list of valid key to use as vcs_type
1443 vcstools.vcs_abstraction.get_vcs(vcs_type)
1445 Returns the class interfacing with vcs of given type
1446 Parameters
1448 vcs_type -- id of the tpye, e.g. git, svn, hg, bzr
1449 Returns
1451 class extending VcsClientBase
1452 Raises ValueError for unknown vcs_type
1454 vcstools.vcs_abstraction.get_vcs_client(vcs_type, path)
1456 Returns a client with which to interact with the vcs at given
1457 path
1458 Parameters
1460 vcs_type -- id of the tpye, e.g. git, svn, hg, bzr
1461 Returns
1463 instance of VcsClientBase
1464 Raises ValueError for unknown vcs_type
1466 vcstools.vcs_abstraction.register_vcs(vcs_type, clazz)
1468 Parameters
1470 · vcs_type -- id, str
1472 · clazz -- class extending VcsClientBase
1474 vcs_base Module
1476 vcs support library base class.
1477 undoc-members
1479 show-inheritance
1481 class vcstools.vcs_base.VcsClientBase(vcs_type_name, path)
1483 Bases: object
1484 parent class for all vcs clients, provides their public API
1486 __init__(vcs_type_name, path)
1488 subclasses may raise VcsError when a dependency is miss‐
1489 ing
1490 checkout(url, version=None, verbose=False, shallow=False, time‐
1492 out=None)
1493 Attempts to create a local repository given a remote url.
1494 Fails if a target path exists, unless it's an empty
1495 directory. If a version is provided, the local reposi‐
1496 tory will be updated to that revision. It is possible
1497 that after a failed call to checkout, a repository still
1498 exists, e.g. if an invalid revision was given. If shal‐
1499 low is provided, the scm client may checkout less than
1500 the full repository history to save time / disk space.
1501 If a timeout is specified, any pending operation will
1502 fail after the specified amount (in seconds). NOTE: this
1503 parameter might or might not be honored, depending on VCS
1504 client implementation. :param url: where to checkout
1505 from :type url: str :param version: token for identifying
1506 repository revision :type version: str :param shallow:
1507 hint to checkout less than a full repository :type shal‐
1508 low: bool :param timeout: maximum allocated time to per‐
1509 form operation :type shallow: int :returns: True if suc‐
1510 cessful
1511 detect_presence()
1513 For auto detection
1514 export_repository(version, basepath)
1516 Calls scm equivalent to svn export, removing scm meta
1517 information and tar gzip'ing the repository at a given
1518 version to the given basepath.
1519 Parameters
1521 version -- version of the repository to export.
1522 This can
1523 be a branch, tag, or path (svn). When specifying the
1525 version as a path for svn, the path should be relative to
1526 the root of the svn repository, i.e. 'trunk', or
1527 'tags/1.2.3', or './' for the root. :param basepath:
1528 this is the path to the tar gzip, excluding the extension
1529 which will be .tar.gz :returns: True on success, False
1530 otherwise.
1531 get_affected_files(revision)
1533 Get the files that were affected by a specific revision
1534 :param revision: SHA or revision number. :returns: A
1535 list of strings with the files affected by a specific
1536 commit
1537 get_branches(local_only=False)
1539 Returns a list of all branches in the vcs repository.
1540 Parameters
1542 local_only -- if True it will only list local
1543 branches
1544 Returns
1546 list of branches in the repository, [] if none
1547 exist
1548 get_current_version_label()
1550 Find an description for the current local version. Token
1551 spec might be a branchname, version-id, SHA-ID, ...
1552 depending on the VCS implementation.
1553 Returns
1555 short description of local version (e.g. branch‐
1556 name, tagename).
1557 Return type
1559 str
1560 get_default_remote_version_label()
1562 Find a label for the default branch on remote, meaning
1563 the one that would be checked out on a clean checkout.
1564 Returns
1566 a label or None (if not applicable)
1567 Return type
1569 str
1570 get_diff(basepath=None)
1572 Parameters
1574 basepath -- diff paths will be relative to this,
1575 if any
1576 Returns
1578 A string showing local differences
1579 Return type
1581 str
1582 static get_environment_metadata()
1584 For debugging purposes, returns a dict containing infor‐
1585 mation about the environment, like the version of the SCM
1586 client, or version of libraries involved. Suggest con‐
1587 sidering keywords "version", "dependency", "features"
1588 first. :returns: a dict containing relevant information
1589 :rtype: dict
1590 get_log(relpath=None, limit=None)
1592 Calls scm log command.
1593 This returns a list of dictionaries with the following
1595 fields:
1596 · id: the commit SHA or revision number
1598 · date: the date the commit was made (python date‐
1600 time)
1601 · author: the name of the author of the commit, if
1603 available
1604 · email: the e-mail address of the author of the
1606 commit
1607 · message: the commit message, if any
1609 Parameters
1611 relpath -- (optional) restrict logs to events on
1612 this
1613 resource path (folder or file) relative to the root of
1615 the repository. If None (default), this is the root of
1616 the repository. :param limit: (optional) the maximum
1617 number of log entries that should be retrieved. If None
1618 (default), there is no limit.
1619 get_path()
1621 returns the path this client was configured for
1622 get_remote_version(fetch=False)
1624 Find an identifier for the current revision on remote.
1625 Token spec might be a tagname, version-id, SHA-ID, ...
1626 depending on the VCS implementation.
1627 Parameters
1629 fetch -- if False, only local information may be
1630 used
1631 Returns
1633 current revision number of the remote repository.
1634 Return type
1636 str
1637 get_status(basepath=None, untracked=False, **kwargs)
1639 Calls scm status command. Output must be terminated by
1640 newline unless empty.
1641 Semantics of untracked are difficult to generalize. In
1643 SVN, this would be new files only. In git, hg, bzr, this
1644 would be changes that have not been added for commit.
1645 Extra keyword arguments are passed along to the underly‐
1647 ing vcs code. See the specific implementations of
1648 get_status() for extra options.
1649 Parameters
1651 · basepath -- status path will be relative to
1653 this, if any
1654 · untracked -- whether to also show changes that
1656 would not commit
1657 Returns
1659 A string summarizing locally modified files
1660 Return type
1662 str
1663 get_url()
1665 Returns
1667 The source control url for the path or None if not
1668 set
1669 Return type
1671 str
1672 get_vcs_type_name()
1674 used when auto detected
1675 get_version(spec=None)
1677 Find an identifier for a the current or a specified revi‐
1678 sion. Token spec might be a tagname, branchname, ver‐
1679 sion-id, SHA-ID, ... depending on the VCS implementation.
1680 Parameters
1682 spec (str) -- token for identifying repository
1683 revision
1684 Returns
1686 current revision number of the repository. Or if
1687 spec is provided, the respective revision number.
1688 Return type
1690 str
1691 path_exists()
1693 helper function
1694 static static_detect_presence(path)
1696 For auto detection
1697 update(version=None, verbose=False, timeout=None)
1699 Sets the local copy of the repository to a version match‐
1700 ing the version parameter. Fails when there are uncom‐
1701 mited changes. On failures (also e.g. network failure)
1702 grants the checked out files are in the same state as
1703 before the call. If a timeout is specified, any pending
1704 operation will fail after the specified amount (in sec‐
1705 onds)
1706 Parameters
1708 · version -- token for identifying repository
1710 revision desired. Token might be a tagname,
1711 branchname, version-id, SHA-ID, ... depending on
1712 the VCS implementation.
1713 · timeout -- maximum allocated time to perform
1715 operation
1716 Returns
1718 True on success, False else
1719 url_matches(url, url_or_shortcut)
1721 client can decide whether the url and the other url are
1722 equivalent. Checks string equality by default :param
1723 url_or_shortcut: url or shortcut (e.g. bzr launchpad url)
1724 :returns: bool if params are equivalent
1725 exception vcstools.vcs_base.VcsError(value)
1727 Bases: Exception
1728 To be thrown when an SCM Client faces a situation because of a
1730 violated assumption
1731 __init__(value)
1733 Initialize self. See help(type(self)) for accurate sig‐
1734 nature.
1735 __str__()
1737 Return str(self).
1738 Changelog
1740 Changelog
1741 0.1
1742 0.1.42
1743 · remove cosmic and disco until we have hosting for it
1744 0.1.41
1746 · fix git submodule error due to lack of quoting
1747 · Fix git update failure by refreshing git index before fast-forward
1749 · Fix python3 incompatibility due to wrong use of urlopen
1751 · Updating get_affected_files function by removing single quotes cover‐
1753 ing format (#129)
1754 · Fix export_upstream for git submodules with relative urls. (#130)
1756 0.1.40
1758 · Trivial style and testing changes
1759 0.1.39
1761 · Added support for git submodule in export_repository
1762 · Add Wily Xenial Yakkety
1764 · Add get_affected_files for all vcss
1766 0.1.38
1768 · Fixed test failures due to SVN 1.9.
1769 · Added the get_default_remote_version_label() API method to support
1771 changes in wstool.
1772 · Renamed some internal functions to have a leading _ to indicate that
1774 they are private.
1775 0.1.37
1777 · Fix an issue where log were restricted to the named branch (hg).
1778 · Fixed svn to use a global revision number rather than a branch-local
1780 revision.
1781 · Added the get_remote_version() and get_current_version_label() API
1783 calls.
1784 · Enhanced use of no_warn in run_shell_command().
1786 · Fix get_version() to catch stderr.
1788 · Added get_branches() API call.
1790 · Fix some errors and warnings to output to stderr.
1792 · Fix output to avoid extra newlines when show_stdout=True.
1794 0.1.36
1796 · Updates to the release platforms (-lucid +utopic +vivid)
1797 · Fix an issue with updating branches on git, see vcstools/wstool#25
1799 0.1.31
1801 · Fix submodule support on checkout #71
1802 0.1.30
1804 · use netrc to download tars from private repos, also will work for
1805 private rosinstall files
1806 · Fix checks for empty repository #62
1808 0.1.29
1810 · fix #57 shallow checkout of non-master breaks with git >= 1.8.0
1811 · unit test fixes
1813 0.1.28
1815 · test of new upload method
1816 0.1.27
1818 · fix #51 hg status and diff dont work if workspace is inside hg repo
1819 · fix #47 several performance improvements by removing unecessary
1821 update actions after checkout
1822 · fix #46 https tar download fails behind proxy
1824 · fix #45 sometimes commands run forever
1826 · fix #44 minor bug when checking out from repo with default branch not
1828 master
1829 · fix #41 improvedAPI, get_vcs_client function part of vcstools module
1831 0.1.26
1833 · fix #38 git commands fail in local repositories with many (>2000)
1834 references
1835 · fix #31 get_log() svn xml not available on Ubuntu Lucid (hg 1.4.2)
1837 · fix #37 update() returns True even when fetch failed
1839 0.1.25
1841 · minor bugfixes
1842 · travis-ci config file
1844 · fix unit tests for svn diff&status ordering changes
1846 · deprecated VcsClient Class
1848 · added get_log function
1850 0.1.24
1852 · fix git update return value to False when fast-forward not possible
1853 due to diverge
1854 · fix. svn certificate prompt invisible, svn checkout and update become
1856 verbose due to this
1857 0.1.22
1859 · Changed the way that git implements detect_presence to fix a bug with
1860 submodules in newer versions of git
1861 · fix for git single quotes on Windows
1863 · minor internal api bug where a git function always returned True
1865 · fix gub in svn export_repository
1867 0.1.21
1869 · bugfix #66: hg http username prompt hidden
1870 · add export_repository method to vcs_base and all implementations with
1872 tests
1873 · bugfix #64: unicode decoding problems
1875 0.1.20
1877 · rosws update –verbose for git prints small message when rebasing
1878 · improved python3 compatibility
1880 0.1.19
1882 · more python3 compatibility
1883 · code style improved
1885 · match_url to compare bzr shortcuts to real urls
1887 · more unit tests
1889 · get_status required to end with newline, to fix #55
1891 0.1.18
1893 · added shallow flag to API, implemented for git
1894 0.1.17
1896 · svn stdout output on get_version removed
1897 0.1.16
1899 · All SCMs show some output when update caused changes
1900 · All SCMs have verbose option to show all changes done on update
1902 · bugfix for bazaar getUrl() being a joined abspath
1904 · bugfix for not all output being shown when requested
1906 0.1.15
1908 · Added pyyaml as a proper dependency, removed detection code.
1909 · remove use of tar entirely, switch to tarfile module
1911 · fix #36 allowing for tar being bsdtar on OSX
1913 0.1.14
1915 · Added tarball uncompression.
1916 0.1.13
1918 · added this changelog
1919 · git get-version fetches only when local lookup fails
1921 · hg get-version pulls if label not found
1923 · Popen error message incudes cwd path
1925 0.1.12
1927 · py_checker clean after all refactorings since 0.1.0
1928 0.1.11
1930 · svn and hg update without user interaction
1931 · bugfix #30
1933 · minor bugfixes
1935 0.1.10
1937 · minor bugs
1938 0.1.9
1940 · safer sanitization of shell params
1941 · git diff and stat recurse for submodules
1943 · base class manages all calls to Popen
1945 0.1.8
1947 · several bugfixes
1948 · reverted using shell commands instead of bazaar API
1950 0.1.7
1952 · reverted using shell commands instaed of pysvn and mercurial APIs
1953 · protection against shell incection attempts
1955 0.1.6
1957 · bugfixes to svn and bzr
1958 · unified all calls through Popen
1960 0.1.5
1962 · missing dependency to dateutil added
1963 0.1.4
1965 switched shell calls to calls to python API of mercurial, bazaar,
1966 py-svn
1967 0.1.3
1969 · fix #6
1970 0.1.2
1972 · fix #15
1973 0.1.1
1975 · more unit tests
1976 · diverse bugfixes
1978 · major change to git client behavior, based around git
1980 https://kforge.ros.org/vcstools/trac/ticket/1
1981 0.1.0
1983 · documentation fixes
1984 0.0.3
1986 · import from svn
1987 Bug reports and feature requests
1989 · Submit a bug report
1990 Developer Setup
1992 vcstools uses setuptools, which you will need to download and install
1993 in order to run the packaging. We use setuptools instead of distutils
1994 in order to be able use setup() keys like install_requires.
1995 cd vcstools python setup.py develop
1996 Testing
1998 Install test dependencies
1999 pip install nose
2001 pip install mock
2002 vcstools uses Python nose for testing, which is a fairly simple and
2004 straightfoward test framework. The vcstools mainly use unittest to
2005 construct test fixtures, but with nose you can also just write a func‐
2006 tion that starts with the name test and use normal assert statements.
2007 vcstools also uses mock to create mocks for testing.
2009 You can run the tests, including coverage, as follows:
2011 cd vcstools
2013 make test
2014 Documentation
2016 Sphinx is used to provide API documentation for vcstools. The docu‐
2017 ments are stored in the doc subdirectory.
2018 · genindex
2020 · modindex
2022 · search
2024
2026 Tully Foote, Thibault Kruse, Ken Conley
2027
2029 2019, Willow Garage
20300.1.42 Oct 03, 2019 VCSTOOLS(1)