mirror of
https://github.com/openSUSE/osc.git
synced 2025-09-05 20:58:42 +02:00
Improve git-obs startup time by loading less python modules
This commit is contained in:
@@ -35,6 +35,7 @@ from . import git_scm
|
||||
from . import oscerr
|
||||
from . import output
|
||||
from . import store as osc_store
|
||||
from .commandline_common import *
|
||||
from .core import *
|
||||
from .grabber import OscFileGrabber
|
||||
from .meter import create_text_meter
|
||||
@@ -44,275 +45,6 @@ from .util import cpio, rpmquery, safewriter
|
||||
from .util.helper import _html_escape, format_table
|
||||
|
||||
|
||||
# python3.6 requires reading sys.real_prefix to detect virtualenv
|
||||
IN_VENV = getattr(sys, "real_prefix", sys.base_prefix) != sys.prefix
|
||||
|
||||
|
||||
class Command:
|
||||
#: Name of the command as used in the argument parser.
|
||||
name: str = None
|
||||
|
||||
#: Optional aliases to the command.
|
||||
aliases: List[str] = []
|
||||
|
||||
#: Whether the command is hidden from help.
|
||||
#: Defaults to ``False``.
|
||||
hidden: bool = False
|
||||
|
||||
#: Name of the parent command class.
|
||||
#: Can be prefixed if the parent comes from a different location,
|
||||
#: for example ``osc.commands.<ClassName>`` when extending osc command with a plugin.
|
||||
#: See ``OscMainCommand.MODULES`` for available prefixes.
|
||||
parent: str = None
|
||||
|
||||
def __init__(self, full_name, parent=None):
|
||||
self.full_name = full_name
|
||||
self.parent = parent
|
||||
self.subparsers = None
|
||||
|
||||
if not self.name:
|
||||
raise ValueError(f"Command '{self.full_name}' has no 'name' set")
|
||||
|
||||
if parent:
|
||||
self.parser = self.parent.subparsers.add_parser(
|
||||
self.name,
|
||||
aliases=self.aliases,
|
||||
help=self.get_help(),
|
||||
description=self.get_description(),
|
||||
formatter_class=cmdln.HelpFormatter,
|
||||
conflict_handler="resolve",
|
||||
prog=f"{self.main_command.name} [global opts] {self.name}",
|
||||
)
|
||||
self.parser.set_defaults(_selected_command=self)
|
||||
else:
|
||||
self.parser = argparse.ArgumentParser(
|
||||
description=self.get_description(),
|
||||
formatter_class=cmdln.HelpFormatter,
|
||||
usage="%(prog)s [global opts] <command> [--help] [opts] [args]",
|
||||
)
|
||||
|
||||
# traverse the parent commands and add their options to the current command
|
||||
commands = []
|
||||
cmd = self
|
||||
while cmd:
|
||||
commands.append(cmd)
|
||||
cmd = cmd.parent
|
||||
# iterating backwards to give the command's options a priority over parent/global options
|
||||
for cmd in reversed(commands):
|
||||
cmd.init_arguments()
|
||||
|
||||
def __repr__(self):
|
||||
return f"<osc plugin {self.full_name} at {self.__hash__():#x}>"
|
||||
|
||||
def get_help(self):
|
||||
"""
|
||||
Return the help text of the command.
|
||||
The first line of the docstring is returned by default.
|
||||
"""
|
||||
if self.hidden:
|
||||
return argparse.SUPPRESS
|
||||
|
||||
if not self.__doc__:
|
||||
return ""
|
||||
|
||||
help_lines = self.__doc__.strip().splitlines()
|
||||
|
||||
if not help_lines:
|
||||
return ""
|
||||
|
||||
return help_lines[0]
|
||||
|
||||
def get_description(self):
|
||||
"""
|
||||
Return the description of the command.
|
||||
The docstring without the first line is returned by default.
|
||||
"""
|
||||
if not self.__doc__:
|
||||
return ""
|
||||
|
||||
help_lines = self.__doc__.strip().splitlines()
|
||||
|
||||
if not help_lines:
|
||||
return ""
|
||||
|
||||
# skip the first line that contains help text
|
||||
help_lines.pop(0)
|
||||
|
||||
# remove any leading empty lines
|
||||
while help_lines and not help_lines[0]:
|
||||
help_lines.pop(0)
|
||||
|
||||
result = "\n".join(help_lines)
|
||||
result = textwrap.dedent(result)
|
||||
return result
|
||||
|
||||
@property
|
||||
def main_command(self):
|
||||
"""
|
||||
Return reference to the main command that represents the executable
|
||||
and contains the main instance of ArgumentParser.
|
||||
"""
|
||||
if not self.parent:
|
||||
return self
|
||||
return self.parent.main_command
|
||||
|
||||
def add_argument(self, *args, **kwargs):
|
||||
"""
|
||||
Add a new argument to the command's argument parser.
|
||||
See `argparse <https://docs.python.org/3/library/argparse.html>`_ documentation for allowed parameters.
|
||||
"""
|
||||
cmd = self
|
||||
|
||||
# Let's inspect if the caller was init_arguments() method.
|
||||
# In such case use the "parser" argument if specified.
|
||||
frame_1 = inspect.currentframe().f_back
|
||||
frame_1_info = inspect.getframeinfo(frame_1)
|
||||
frame_2 = frame_1.f_back
|
||||
frame_2_info = inspect.getframeinfo(frame_2)
|
||||
if (frame_1_info.function, frame_2_info.function) == ("init_arguments", "__init__"):
|
||||
# this method was called from init_arguments() that was called from __init__
|
||||
# let's extract the command class from the 2nd frame and ad arguments there
|
||||
cmd = frame_2.f_locals["self"]
|
||||
|
||||
# suppress global options from command help
|
||||
if cmd != self and not self.parent:
|
||||
kwargs["help"] = argparse.SUPPRESS
|
||||
|
||||
# We're adding hidden options from parent commands to their subcommands to allow
|
||||
# option intermixing. For all such added hidden options we need to suppress their
|
||||
# defaults because they would override any option set in the parent command.
|
||||
if cmd != self:
|
||||
kwargs["default"] = argparse.SUPPRESS
|
||||
|
||||
cmd.parser.add_argument(*args, **kwargs)
|
||||
|
||||
def init_arguments(self):
|
||||
"""
|
||||
Override to add arguments to the argument parser.
|
||||
|
||||
.. note::
|
||||
Make sure you're adding arguments only by calling ``self.add_argument()``.
|
||||
Using ``self.parser.add_argument()`` directly is not recommended
|
||||
because it disables argument intermixing.
|
||||
"""
|
||||
|
||||
def run(self, args):
|
||||
"""
|
||||
Override to implement the command functionality.
|
||||
|
||||
.. note::
|
||||
``args.positional_args`` is a list containing any unknown (unparsed) positional arguments.
|
||||
|
||||
.. note::
|
||||
Consider moving any reusable code into a library,
|
||||
leaving the command-line code only a thin wrapper on top of it.
|
||||
|
||||
If the code is generic enough, it should be added to osc directly.
|
||||
In such case don't hesitate to open an `issue <https://github.com/openSUSE/osc/issues>`_.
|
||||
"""
|
||||
raise NotImplementedError()
|
||||
|
||||
def register(self, command_class, command_full_name):
|
||||
if not self.subparsers:
|
||||
# instantiate subparsers on first use
|
||||
self.subparsers = self.parser.add_subparsers(dest="command", title="commands")
|
||||
|
||||
# Check for parser conflicts.
|
||||
# This is how Python 3.11+ behaves by default.
|
||||
if command_class.name in self.subparsers._name_parser_map:
|
||||
raise argparse.ArgumentError(self.subparsers, f"conflicting subparser: {command_class.name}")
|
||||
for alias in command_class.aliases:
|
||||
if alias in self.subparsers._name_parser_map:
|
||||
raise argparse.ArgumentError(self.subparsers, f"conflicting subparser alias: {alias}")
|
||||
|
||||
command = command_class(command_full_name, parent=self)
|
||||
return command
|
||||
|
||||
|
||||
class MainCommand(Command):
|
||||
MODULES = ()
|
||||
|
||||
def __init__(self):
|
||||
super().__init__(self.__class__.__name__)
|
||||
self.command_classes = {}
|
||||
self.download_progress = None
|
||||
|
||||
def post_parse_args(self, args):
|
||||
pass
|
||||
|
||||
def run(self, args):
|
||||
cmd = getattr(args, "_selected_command", None)
|
||||
if not cmd:
|
||||
self.parser.error("Please specify a command")
|
||||
self.post_parse_args(args)
|
||||
return cmd.run(args)
|
||||
|
||||
def load_command(self, cls, module_prefix):
|
||||
mod_cls_name = f"{module_prefix}.{cls.__name__}"
|
||||
parent_name = getattr(cls, "parent", None)
|
||||
if parent_name:
|
||||
# allow relative references to classes in the the same module/directory
|
||||
if "." not in parent_name:
|
||||
parent_name = f"{module_prefix}.{parent_name}"
|
||||
try:
|
||||
parent = self.main_command.command_classes[parent_name]
|
||||
except KeyError:
|
||||
msg = f"Failed to load command class '{mod_cls_name}' because it references parent '{parent_name}' that doesn't exist"
|
||||
print(msg, file=sys.stderr)
|
||||
return None
|
||||
cmd = parent.register(cls, mod_cls_name)
|
||||
else:
|
||||
cmd = self.main_command.register(cls, mod_cls_name)
|
||||
|
||||
cmd.full_name = mod_cls_name
|
||||
self.main_command.command_classes[mod_cls_name] = cmd
|
||||
return cmd
|
||||
|
||||
def load_commands(self):
|
||||
if IN_VENV:
|
||||
output.print_msg("Running in virtual environment, skipping loading plugins installed outside the virtual environment.", print_to="debug")
|
||||
|
||||
for module_prefix, module_path in self.MODULES:
|
||||
module_path = os.path.expanduser(module_path)
|
||||
|
||||
# some plugins have their modules installed next to them instead of site-packages
|
||||
if module_path not in sys.path:
|
||||
sys.path.append(module_path)
|
||||
|
||||
for loader, module_name, _ in pkgutil.iter_modules(path=[module_path]):
|
||||
full_name = f"{module_prefix}.{module_name}"
|
||||
spec = loader.find_spec(full_name)
|
||||
mod = importlib.util.module_from_spec(spec)
|
||||
try:
|
||||
spec.loader.exec_module(mod)
|
||||
except Exception as e: # pylint: disable=broad-except
|
||||
msg = f"Failed to load commands from module '{full_name}': {e}"
|
||||
print(msg, file=sys.stderr)
|
||||
continue
|
||||
for name in dir(mod):
|
||||
if name.startswith("_"):
|
||||
continue
|
||||
cls = getattr(mod, name)
|
||||
if not inspect.isclass(cls):
|
||||
continue
|
||||
if not issubclass(cls, Command):
|
||||
continue
|
||||
if cls.__module__ != full_name:
|
||||
# skip classes that weren't defined directly in the loaded plugin module
|
||||
continue
|
||||
self.load_command(cls, module_prefix)
|
||||
|
||||
def parse_args(self, *args, **kwargs):
|
||||
namespace, unknown_args = self.parser.parse_known_args(*args, **kwargs)
|
||||
|
||||
unrecognized = [i for i in unknown_args if i.startswith("-")]
|
||||
if unrecognized:
|
||||
self.parser.error(f"unrecognized arguments: " + " ".join(unrecognized))
|
||||
|
||||
namespace.positional_args = list(unknown_args)
|
||||
return namespace
|
||||
|
||||
|
||||
class OscCommand(Command):
|
||||
"""
|
||||
Inherit from this class to create new commands.
|
||||
|
||||
280
osc/commandline_common.py
Normal file
280
osc/commandline_common.py
Normal file
@@ -0,0 +1,280 @@
|
||||
import argparse
|
||||
import importlib
|
||||
import inspect
|
||||
import os
|
||||
import pkgutil
|
||||
import sys
|
||||
import textwrap
|
||||
from typing import List
|
||||
|
||||
from . import cmdln
|
||||
|
||||
|
||||
# python3.6 requires reading sys.real_prefix to detect virtualenv
|
||||
IN_VENV = getattr(sys, "real_prefix", sys.base_prefix) != sys.prefix
|
||||
|
||||
|
||||
class Command:
|
||||
#: Name of the command as used in the argument parser.
|
||||
name: str = None
|
||||
|
||||
#: Optional aliases to the command.
|
||||
aliases: List[str] = []
|
||||
|
||||
#: Whether the command is hidden from help.
|
||||
#: Defaults to ``False``.
|
||||
hidden: bool = False
|
||||
|
||||
#: Name of the parent command class.
|
||||
#: Can be prefixed if the parent comes from a different location,
|
||||
#: for example ``osc.commands.<ClassName>`` when extending osc command with a plugin.
|
||||
#: See ``OscMainCommand.MODULES`` for available prefixes.
|
||||
parent: str = None
|
||||
|
||||
def __init__(self, full_name, parent=None):
|
||||
self.full_name = full_name
|
||||
self.parent = parent
|
||||
self.subparsers = None
|
||||
|
||||
if not self.name:
|
||||
raise ValueError(f"Command '{self.full_name}' has no 'name' set")
|
||||
|
||||
if parent:
|
||||
self.parser = self.parent.subparsers.add_parser(
|
||||
self.name,
|
||||
aliases=self.aliases,
|
||||
help=self.get_help(),
|
||||
description=self.get_description(),
|
||||
formatter_class=cmdln.HelpFormatter,
|
||||
conflict_handler="resolve",
|
||||
prog=f"{self.main_command.name} [global opts] {self.name}",
|
||||
)
|
||||
self.parser.set_defaults(_selected_command=self)
|
||||
else:
|
||||
self.parser = argparse.ArgumentParser(
|
||||
description=self.get_description(),
|
||||
formatter_class=cmdln.HelpFormatter,
|
||||
usage="%(prog)s [global opts] <command> [--help] [opts] [args]",
|
||||
)
|
||||
|
||||
# traverse the parent commands and add their options to the current command
|
||||
commands = []
|
||||
cmd = self
|
||||
while cmd:
|
||||
commands.append(cmd)
|
||||
cmd = cmd.parent
|
||||
# iterating backwards to give the command's options a priority over parent/global options
|
||||
for cmd in reversed(commands):
|
||||
cmd.init_arguments()
|
||||
|
||||
def __repr__(self):
|
||||
return f"<osc plugin {self.full_name} at {self.__hash__():#x}>"
|
||||
|
||||
def get_help(self):
|
||||
"""
|
||||
Return the help text of the command.
|
||||
The first line of the docstring is returned by default.
|
||||
"""
|
||||
if self.hidden:
|
||||
return argparse.SUPPRESS
|
||||
|
||||
if not self.__doc__:
|
||||
return ""
|
||||
|
||||
help_lines = self.__doc__.strip().splitlines()
|
||||
|
||||
if not help_lines:
|
||||
return ""
|
||||
|
||||
return help_lines[0]
|
||||
|
||||
def get_description(self):
|
||||
"""
|
||||
Return the description of the command.
|
||||
The docstring without the first line is returned by default.
|
||||
"""
|
||||
if not self.__doc__:
|
||||
return ""
|
||||
|
||||
help_lines = self.__doc__.strip().splitlines()
|
||||
|
||||
if not help_lines:
|
||||
return ""
|
||||
|
||||
# skip the first line that contains help text
|
||||
help_lines.pop(0)
|
||||
|
||||
# remove any leading empty lines
|
||||
while help_lines and not help_lines[0]:
|
||||
help_lines.pop(0)
|
||||
|
||||
result = "\n".join(help_lines)
|
||||
result = textwrap.dedent(result)
|
||||
return result
|
||||
|
||||
@property
|
||||
def main_command(self):
|
||||
"""
|
||||
Return reference to the main command that represents the executable
|
||||
and contains the main instance of ArgumentParser.
|
||||
"""
|
||||
if not self.parent:
|
||||
return self
|
||||
return self.parent.main_command
|
||||
|
||||
def add_argument(self, *args, **kwargs):
|
||||
"""
|
||||
Add a new argument to the command's argument parser.
|
||||
See `argparse <https://docs.python.org/3/library/argparse.html>`_ documentation for allowed parameters.
|
||||
"""
|
||||
cmd = self
|
||||
|
||||
# Let's inspect if the caller was init_arguments() method.
|
||||
# In such case use the "parser" argument if specified.
|
||||
frame_1 = inspect.currentframe().f_back
|
||||
frame_1_info = inspect.getframeinfo(frame_1)
|
||||
frame_2 = frame_1.f_back
|
||||
frame_2_info = inspect.getframeinfo(frame_2)
|
||||
if (frame_1_info.function, frame_2_info.function) == ("init_arguments", "__init__"):
|
||||
# this method was called from init_arguments() that was called from __init__
|
||||
# let's extract the command class from the 2nd frame and ad arguments there
|
||||
cmd = frame_2.f_locals["self"]
|
||||
|
||||
# suppress global options from command help
|
||||
if cmd != self and not self.parent:
|
||||
kwargs["help"] = argparse.SUPPRESS
|
||||
|
||||
# We're adding hidden options from parent commands to their subcommands to allow
|
||||
# option intermixing. For all such added hidden options we need to suppress their
|
||||
# defaults because they would override any option set in the parent command.
|
||||
if cmd != self:
|
||||
kwargs["default"] = argparse.SUPPRESS
|
||||
|
||||
cmd.parser.add_argument(*args, **kwargs)
|
||||
|
||||
def init_arguments(self):
|
||||
"""
|
||||
Override to add arguments to the argument parser.
|
||||
|
||||
.. note::
|
||||
Make sure you're adding arguments only by calling ``self.add_argument()``.
|
||||
Using ``self.parser.add_argument()`` directly is not recommended
|
||||
because it disables argument intermixing.
|
||||
"""
|
||||
|
||||
def run(self, args):
|
||||
"""
|
||||
Override to implement the command functionality.
|
||||
|
||||
.. note::
|
||||
``args.positional_args`` is a list containing any unknown (unparsed) positional arguments.
|
||||
|
||||
.. note::
|
||||
Consider moving any reusable code into a library,
|
||||
leaving the command-line code only a thin wrapper on top of it.
|
||||
|
||||
If the code is generic enough, it should be added to osc directly.
|
||||
In such case don't hesitate to open an `issue <https://github.com/openSUSE/osc/issues>`_.
|
||||
"""
|
||||
raise NotImplementedError()
|
||||
|
||||
def register(self, command_class, command_full_name):
|
||||
if not self.subparsers:
|
||||
# instantiate subparsers on first use
|
||||
self.subparsers = self.parser.add_subparsers(dest="command", title="commands")
|
||||
|
||||
# Check for parser conflicts.
|
||||
# This is how Python 3.11+ behaves by default.
|
||||
if command_class.name in self.subparsers._name_parser_map:
|
||||
raise argparse.ArgumentError(self.subparsers, f"conflicting subparser: {command_class.name}")
|
||||
for alias in command_class.aliases:
|
||||
if alias in self.subparsers._name_parser_map:
|
||||
raise argparse.ArgumentError(self.subparsers, f"conflicting subparser alias: {alias}")
|
||||
|
||||
command = command_class(command_full_name, parent=self)
|
||||
return command
|
||||
|
||||
|
||||
class MainCommand(Command):
|
||||
MODULES = ()
|
||||
|
||||
def __init__(self):
|
||||
super().__init__(self.__class__.__name__)
|
||||
self.command_classes = {}
|
||||
self.download_progress = None
|
||||
|
||||
def post_parse_args(self, args):
|
||||
pass
|
||||
|
||||
def run(self, args):
|
||||
cmd = getattr(args, "_selected_command", None)
|
||||
if not cmd:
|
||||
self.parser.error("Please specify a command")
|
||||
self.post_parse_args(args)
|
||||
return cmd.run(args)
|
||||
|
||||
def load_command(self, cls, module_prefix):
|
||||
mod_cls_name = f"{module_prefix}.{cls.__name__}"
|
||||
parent_name = getattr(cls, "parent", None)
|
||||
if parent_name:
|
||||
# allow relative references to classes in the the same module/directory
|
||||
if "." not in parent_name:
|
||||
parent_name = f"{module_prefix}.{parent_name}"
|
||||
try:
|
||||
parent = self.main_command.command_classes[parent_name]
|
||||
except KeyError:
|
||||
msg = f"Failed to load command class '{mod_cls_name}' because it references parent '{parent_name}' that doesn't exist"
|
||||
print(msg, file=sys.stderr)
|
||||
return None
|
||||
cmd = parent.register(cls, mod_cls_name)
|
||||
else:
|
||||
cmd = self.main_command.register(cls, mod_cls_name)
|
||||
|
||||
cmd.full_name = mod_cls_name
|
||||
self.main_command.command_classes[mod_cls_name] = cmd
|
||||
return cmd
|
||||
|
||||
def load_commands(self):
|
||||
if IN_VENV:
|
||||
from . import output # pylint: disable=import-outside-toplevel
|
||||
output.print_msg("Running in virtual environment, skipping loading plugins installed outside the virtual environment.", print_to="debug")
|
||||
|
||||
for module_prefix, module_path in self.MODULES:
|
||||
module_path = os.path.expanduser(module_path)
|
||||
|
||||
# some plugins have their modules installed next to them instead of site-packages
|
||||
if module_path not in sys.path:
|
||||
sys.path.append(module_path)
|
||||
|
||||
for loader, module_name, _ in pkgutil.iter_modules(path=[module_path]):
|
||||
full_name = f"{module_prefix}.{module_name}"
|
||||
spec = loader.find_spec(full_name)
|
||||
mod = importlib.util.module_from_spec(spec)
|
||||
try:
|
||||
spec.loader.exec_module(mod)
|
||||
except Exception as e: # pylint: disable=broad-except
|
||||
msg = f"Failed to load commands from module '{full_name}': {e}"
|
||||
print(msg, file=sys.stderr)
|
||||
continue
|
||||
for name in dir(mod):
|
||||
if name.startswith("_"):
|
||||
continue
|
||||
cls = getattr(mod, name)
|
||||
if not inspect.isclass(cls):
|
||||
continue
|
||||
if not issubclass(cls, Command):
|
||||
continue
|
||||
if cls.__module__ != full_name:
|
||||
# skip classes that weren't defined directly in the loaded plugin module
|
||||
continue
|
||||
self.load_command(cls, module_prefix)
|
||||
|
||||
def parse_args(self, *args, **kwargs):
|
||||
namespace, unknown_args = self.parser.parse_known_args(*args, **kwargs)
|
||||
|
||||
unrecognized = [i for i in unknown_args if i.startswith("-")]
|
||||
if unrecognized:
|
||||
self.parser.error(f"unrecognized arguments: " + " ".join(unrecognized))
|
||||
|
||||
namespace.positional_args = list(unknown_args)
|
||||
return namespace
|
||||
@@ -1,14 +1,13 @@
|
||||
import os
|
||||
import sys
|
||||
|
||||
import osc.commandline
|
||||
import osc.commandline_common
|
||||
import osc.commands_git
|
||||
from . import gitea_api
|
||||
from . import oscerr
|
||||
from .output import print_msg
|
||||
|
||||
|
||||
class GitObsCommand(osc.commandline.Command):
|
||||
class GitObsCommand(osc.commandline_common.Command):
|
||||
@property
|
||||
def gitea_conf(self):
|
||||
return self.main_command.gitea_conf
|
||||
@@ -48,7 +47,7 @@ class GitObsCommand(osc.commandline.Command):
|
||||
)
|
||||
|
||||
|
||||
class GitObsMainCommand(osc.commandline.MainCommand):
|
||||
class GitObsMainCommand(osc.commandline_common.MainCommand):
|
||||
name = "git-obs"
|
||||
|
||||
MODULES = (
|
||||
@@ -105,6 +104,8 @@ class GitObsMainCommand(osc.commandline.MainCommand):
|
||||
|
||||
@property
|
||||
def gitea_conf(self):
|
||||
from . import gitea_api
|
||||
|
||||
if self._gitea_conf is None:
|
||||
self._gitea_conf = gitea_api.Config(self._args.gitea_config)
|
||||
return self._gitea_conf
|
||||
@@ -117,6 +118,8 @@ class GitObsMainCommand(osc.commandline.MainCommand):
|
||||
|
||||
@property
|
||||
def gitea_conn(self):
|
||||
from . import gitea_api
|
||||
|
||||
if self._gitea_conn is None:
|
||||
self._gitea_conn = gitea_api.Connection(self.gitea_login)
|
||||
assert self._gitea_login is not None
|
||||
|
||||
Reference in New Issue
Block a user