Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

type Distribution.get_command_obj to not return None with create=True #307

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion distutils/dist.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,15 @@
Provides the Distribution class, which represents the module distribution
being built/installed/distributed.
"""
from __future__ import annotations

import contextlib
import logging
import os
import pathlib
import re
import sys
from typing import TYPE_CHECKING, Literal, overload
import warnings
from collections.abc import Iterable
from email import message_from_file
Expand All @@ -27,6 +29,10 @@
from .fancy_getopt import FancyGetopt, translate_longopt
from .util import check_environ, rfc822_escape, strtobool

if TYPE_CHECKING:
# type-only import because of mutual dependence between these modules
from .cmd import Command

# Regex to define acceptable Distutils command names. This is not *quite*
# the same as a Python NAME -- I don't allow leading underscores. The fact
# that they're very similar is no coincidence; the default naming scheme is
Expand Down Expand Up @@ -829,7 +835,11 @@ def get_command_class(self, command):

raise DistutilsModuleError(f"invalid command '{command}'")

def get_command_obj(self, command, create=True):
@overload
def get_command_obj(self, command: str, create: Literal[True] = True) -> Command: ...
@overload
def get_command_obj(self, command: str, create: Literal[False]) -> Command | None: ...
def get_command_obj(self, command: str, create: bool = True) -> Command | None:
"""Return the command object for 'command'. Normally this object
is cached on a previous call to 'get_command_obj()'; if no command
object for 'command' is in the cache, then we either create and
Expand Down
Loading