class Core:
"""A high level object that manages all classes and configurations"""
def __init__(self):
self.version = importlib_metadata.version(__name__.split(".")[0])
self.project_class = Project
self.repository_class = PyPIRepository
self.resolver_class = Resolver
self.synchronizer_class = Synchronizer
self.parser = None
self.subparsers = None
def init_parser(self):
self.parser = PdmParser(
prog="pdm",
description="PDM - Python Development Master",
formatter_class=PdmFormatter,
)
self.parser.is_root = True
self.parser.add_argument(
"-V",
"--version",
action="version",
version="{}, version {}".format(
click.style("pdm", bold=True), self.version
),
help="show the version and exit",
)
verbose_option.add_to_parser(self.parser)
pep582_option.add_to_parser(self.parser)
self.subparsers = self.parser.add_subparsers()
for _, name, _ in pkgutil.iter_modules(COMMANDS_MODULE_PATH):
module = importlib.import_module(f"pdm.cli.commands.{name}", __name__)
try:
klass = module.Command # type: Type[BaseCommand]
except AttributeError:
continue
self.register_command(klass, klass.name or name)
def __call__(self, *args, **kwargs):
return self.main(*args, **kwargs)
def main(self, args=None, prog_name=None, obj=None, **extra):
"""The main entry function"""
from pdm.models.pip_shims import global_tempdir_manager
self.init_parser()
self.load_plugins()
self.parser.set_defaults(global_project=None)
options = self.parser.parse_args(args or None)
stream.set_verbosity(options.verbose)
if obj is not None:
options.project = obj
if options.global_project:
options.project = options.global_project
if options.pep582:
print_pep582_command(options.pep582)
sys.exit(0)
if not getattr(options, "project", None):
options.project = self.project_class()
# Add reverse reference for core object
options.project.core = self
migrate_pyproject(options.project)
try:
f = options.handler
except AttributeError:
self.parser.print_help()
sys.exit(1)
else:
try:
with global_tempdir_manager():
f(options.project, options)
except Exception:
etype, err, traceback = sys.exc_info()
if stream.verbosity > stream.NORMAL:
raise err.with_traceback(traceback)
stream.echo(
f"{stream.red('[' + etype.__name__ + ']')}: {err}", err=True
)
sys.exit(1)
def register_command(
self, command: Type[BaseCommand], name: Optional[str] = None
) -> None:
"""Register a subcommand to the subparsers,
with an optional name of the subcommand.
"""
command.project_class = self.project_class
command.register_to(self.subparsers, name)
@staticmethod
def add_config(name: str, config_item: ConfigItem) -> None:
"""Add a config item to the configuration class"""
Config.add_config(name, config_item)
def load_plugins(self):
"""Import and load plugins under `pdm.plugin` namespace
A plugin is a callable that accepts the core object as the only argument.
:Example:
def my_plugin(core: pdm.core.Core) -> None:
...
"""
for plugin in pkg_resources.iter_entry_points("pdm.plugin"):
plugin.load()(self)
class Core:
"""A high level object that manages all classes and configurations"""
def __init__(self) -> None:
if sys.version_info >= (3, 8):
import importlib.metadata as importlib_metadata
else:
import importlib_metadata
self.version = importlib_metadata.version(__name__.split(".")[0])
self.project_class = Project
self.repository_class = PyPIRepository
self.resolver_class = Resolver
self.synchronizer_class = Synchronizer
self.ui = termui.UI()
self.parser: Optional[PdmParser] = None
self.subparsers: Optional[argparse._SubParsersAction] = None
def init_parser(self) -> None:
self.parser = PdmParser(
prog="pdm",
description="PDM - Python Development Master",
formatter_class=PdmFormatter,
)
self.parser.is_root = True # type: ignore
self.parser.add_argument(
"-V",
"--version",
action="version",
version="{}, version {}".format(click.style("pdm", bold=True),
self.version),
help="show the version and exit",
)
verbose_option.add_to_parser(self.parser)
ignore_python_option.add_to_parser(self.parser)
pep582_option.add_to_parser(self.parser)
self.subparsers = self.parser.add_subparsers()
for _, name, _ in pkgutil.iter_modules(COMMANDS_MODULE_PATH):
module = importlib.import_module(f"pdm.cli.commands.{name}",
__name__)
try:
klass = module.Command # type: ignore
except AttributeError:
continue
self.register_command(klass, klass.name or name)
def __call__(self, *args: Any, **kwargs: Any) -> None:
return self.main(*args, **kwargs)
def ensure_project(self, options: argparse.Namespace,
obj: Optional[Project]) -> None:
if obj is not None:
options.project = obj
if getattr(options, "project", None) is None:
global_project = getattr(options, "global_project", None)
default_root = (None if global_project or getattr(
options, "search_parent", True) else ".")
project = self.create_project(
getattr(options, "project_path", None)
or default_root, # type: ignore
is_global=global_project,
)
options.project = project
migrate_pyproject(options.project)
def create_project(self,
root_path: Optional[os.PathLike] = None,
is_global: bool = False) -> Project:
return self.project_class(self, root_path, is_global)
def main(
self,
args: List[str] = None,
prog_name: str = None,
obj: Optional[Project] = None,
**extra: Any,
) -> None:
"""The main entry function"""
from pdm.models.pip_shims import global_tempdir_manager
self.init_parser()
self.load_plugins()
assert self.parser
assert self.subparsers
options = self.parser.parse_args(args or None)
self.ui.set_verbosity(options.verbose)
if options.ignore_python:
os.environ["PDM_IGNORE_SAVED_PYTHON"] = "1"
if options.pep582:
print_pep582_command(self.ui, options.pep582)
sys.exit(0)
self.ensure_project(options, obj)
try:
f = options.handler
except AttributeError:
self.parser.print_help()
sys.exit(1)
else:
try:
with global_tempdir_manager():
f(options.project, options)
except Exception:
etype, err, traceback = sys.exc_info()
should_show_tb = not isinstance(err, PdmUsageError)
if self.ui.verbosity > termui.NORMAL and should_show_tb:
raise cast(Exception, err).with_traceback(traceback)
self.ui.echo(
f"{termui.red('[' + etype.__name__ + ']')}: {err}", # type: ignore
err=True,
)
if should_show_tb:
self.ui.echo("Add '-v' to see the detailed traceback",
fg="yellow")
sys.exit(1)
def register_command(self,
command: Type[BaseCommand],
name: Optional[str] = None) -> None:
"""Register a subcommand to the subparsers,
with an optional name of the subcommand.
"""
assert self.subparsers
command.register_to(self.subparsers, name)
@staticmethod
def add_config(name: str, config_item: ConfigItem) -> None:
"""Add a config item to the configuration class"""
Config.add_config(name, config_item)
def load_plugins(self) -> None:
"""Import and load plugins under `pdm.plugin` namespace
A plugin is a callable that accepts the core object as the only argument.
:Example:
def my_plugin(core: pdm.core.Core) -> None:
...
"""
for plugin in pkg_resources.iter_entry_points("pdm"):
plugin.load()(self)