Class Submitter

src/ghstack/submit.py:277–1948

A class responsible for managing the environment associated with submitting PRs at GitHub.

@dataclass(frozen=True)
class Submitter:
    """
    A class responsible for managing the environment associated
    with submitting PRs at GitHub.
    """

    # ---------------------------
    # Direct arguments to submit

    # Message describing the update to the stack that was done
    msg: Optional[str]

    # GitHub username who is doing the submitting
    username: str

    # Endpoint to access GitHub
    github: ghstack.github.GitHubEndpoint

    # Clobber existing PR description with local commit message
    update_fields: bool = False

    # Shell inside git checkout that we are submitting
    sh: ghstack.shell.Shell = dataclasses.field(default_factory=ghstack.shell.Shell)

    # String used to describe the stack in question
    stack_header: str = STACK_HEADER

    # Owner of the repository we are submitting to.  Usually 'pytorch'
    # Presents as repo_owner kwarg in main
    repo_owner_opt: Optional[str] = None

    # Name of the repository we are submitting to.  Usually 'pytorch'
    # Presents as repo_name kwarg in main
    repo_name_opt: Optional[str] = None

    # Print only PR URL to stdout
    short: bool = False

    # Force an update to GitHub, even if we think that your local copy
    # is stale.
    force: bool = False

    # Do not skip unchanged diffs
    no_skip: bool = False

    # Create the PR in draft mode if it is going to be created (and not updated).
    draft: bool = False

    # Github url (normally github.com)
    github_url: str = "github.com"

    # Name of the upstream remote (normally origin)
    remote_name: str = "origin"

    base_opt: Optional[str] = None

    revs: Sequence[str] = ()