RevOptions Class Reference

Public Member Functions
None	__init__ (self, Type["VersionControl"] vc_class, Optional[str] rev=None, Optional[CommandArgs] extra_args=None)
str	__repr__ (self)
Optional[str]	arg_rev (self)
CommandArgs	to_args (self)
str	to_display (self)
"RevOptions"	make_new (self, str rev)

Data Fields
	extra_args
	rev
	vc_class

Detailed Description

Encapsulates a VCS-specific revision to install, along with any VCS
install options.

Instances of this class should be treated as if immutable.

Definition at line 124 of file versioncontrol.py.

Constructor & Destructor Documentation

__init__()

None __init__	(		self,
		Type["VersionControl"]	vc_class,
		Optional[str]	rev = None,
		Optional[CommandArgs]	extra_args = None
	)

Args:
  vc_class: a VersionControl subclass.
  rev: the name of the revision to install.
  extra_args: a list of extra options.

Definition at line 133 of file versioncontrol.py.

    ) -> None:
        """
        Args:
          vc_class: a VersionControl subclass.
          rev: the name of the revision to install.
          extra_args: a list of extra options.
        """
        if extra_args is None:
            extra_args = []
 
        self.extra_args = extra_args
        self.rev = rev
        self.vc_class = vc_class
        self.branch_name: Optional[str] = None
 

Referenced by Protocol.__init_subclass__().

Here is the caller graph for this function:

Member Function Documentation

__repr__()

str __repr__

(

self

)

Definition at line 153 of file versioncontrol.py.

    def __repr__(self) -> str:
        return f"<RevOptions {self.vc_class.name}: rev={self.rev!r}>"
 

arg_rev()

Optional[str] arg_rev

(

self

)

Definition at line 157 of file versioncontrol.py.

    def arg_rev(self) -> Optional[str]:
        if self.rev is None:
            return self.vc_class.default_arg_rev
 
        return self.rev
 

References RevOptions.rev, and RevOptions.vc_class.

Referenced by RevOptions.to_args().

Here is the caller graph for this function:

make_new()

"RevOptions" make_new	(		self,
		str	rev
	)

Make a copy of the current instance, but with a new rev.

Args:
  rev: the name of the revision for the new object.

Definition at line 181 of file versioncontrol.py.

    def make_new(self, rev: str) -> "RevOptions":
        """
        Make a copy of the current instance, but with a new rev.
 
        Args:
          rev: the name of the revision for the new object.
        """
        return self.vc_class.make_rev_options(rev, extra_args=self.extra_args)
 
 

References RevOptions.extra_args, and RevOptions.vc_class.

to_args()

CommandArgs to_args

(

self

)

Return the VCS-specific command arguments.

Definition at line 163 of file versioncontrol.py.

    def to_args(self) -> CommandArgs:
        """
        Return the VCS-specific command arguments.
        """
        args: CommandArgs = []
        rev = self.arg_rev
        if rev is not None:
            args += self.vc_class.get_base_rev_args(rev)
        args += self.extra_args
 
        return args
 

References RevOptions.arg_rev(), RevOptions.extra_args, and RevOptions.vc_class.

Here is the call graph for this function:

to_display()

str to_display

(

self

)

Definition at line 175 of file versioncontrol.py.

    def to_display(self) -> str:
        if not self.rev:
            return ""
 
        return f" (to revision {self.rev})"
 

References RevOptions.rev.

Field Documentation

extra_args

extra_args

Definition at line 148 of file versioncontrol.py.

Referenced by RevOptions.make_new(), and RevOptions.to_args().

rev

rev

Definition at line 149 of file versioncontrol.py.

Referenced by RevOptions.arg_rev(), and RevOptions.to_display().

vc_class

vc_class

Definition at line 150 of file versioncontrol.py.

Referenced by RevOptions.arg_rev(), RevOptions.make_new(), and RevOptions.to_args().

---

The documentation for this class was generated from the following file:

• /home/liwuen/projects_dev/pqc-engineering-ssec-23/venv/lib/python3.12/site-packages/pip/_internal/vcs/versioncontrol.py