Implement unified "pio pkg install" CLI // Issue #3373

This commit is contained in:
Ivan Kravets committed 2022-03-08 14:58:01 +02:00
1 parent f445cb7895
commit 9e40eb992e
10 files changed
+584 -18

No files matched your search

+2
View File
@@ -15,6 +15,7 @@
import click
from platformio.package.commands.exec import package_exec_cmd
from platformio.package.commands.install import package_install_cmd
from platformio.package.commands.outdated import package_outdated_cmd
from platformio.package.commands.pack import package_pack_cmd
from platformio.package.commands.publish import package_publish_cmd
@@ -25,6 +26,7 @@ from platformio.package.commands.unpublish import package_unpublish_cmd
"pkg",
commands=[
package_exec_cmd,
package_install_cmd,
package_outdated_cmd,
package_pack_cmd,
package_publish_cmd,
+6
View File
@@ -14,6 +14,7 @@
from platformio.commands.platform import init_platform
from platformio.commands.test.processor import CTX_META_TEST_RUNNING_NAME
from platformio.package.commands.install import install_project_env_dependencies
from platformio.project.exception import UndefinedEnvPlatformError
# pylint: disable=too-many-instance-attributes
@@ -64,6 +65,11 @@ class EnvironmentProcessor(object):
if "monitor" in build_targets:
build_targets.remove("monitor")
install_project_env_dependencies(
self.name,
{"project_targets": build_targets},
)
result = init_platform(self.options["platform"]).run(
build_vars, build_targets, self.silent, self.verbose, self.jobs
)
+194
View File
@@ -0,0 +1,194 @@
# Copyright (c) 2014-present PlatformIO <contact@platformio.org>
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import logging
import os
import click
from platformio import fs
from platformio.package.manager.library import LibraryPackageManager
from platformio.package.manager.platform import PlatformPackageManager
from platformio.package.manager.tool import ToolPackageManager
from platformio.project.config import ProjectConfig
@click.command(
"install", short_help="Install the project dependencies or custom packages"
)
@click.option(
"-d",
"--project-dir",
default=os.getcwd,
type=click.Path(exists=True, file_okay=False, dir_okay=True, resolve_path=True),
)
@click.option("-e", "--environment", "environments", multiple=True)
@click.option("-p", "--platform", "platforms", multiple=True)
@click.option("-t", "--tool", "tools", multiple=True)
@click.option("-l", "--library", "libraries", multiple=True)
@click.option("--skip-dependencies", is_flag=True, help="Skip package dependencies")
@click.option("-g", "--global", is_flag=True, help="Install package globally")
@click.option(
"--storage-dir",
default=None,
type=click.Path(exists=True, file_okay=False, dir_okay=True, resolve_path=True),
help="Custom package storage directory",
)
@click.option("-f", "--force", is_flag=True, help="Reinstall package if it exists")
@click.option("-s", "--silent", is_flag=True, help="Suppress progress reporting")
def package_install_cmd(**options):
if options.get("global"):
install_global_dependencies(options)
else:
install_project_dependencies(options)
def install_global_dependencies(options):
pm = PlatformPackageManager(options.get("storage_dir"))
tm = ToolPackageManager(options.get("storage_dir"))
lm = LibraryPackageManager(options.get("storage_dir"))
for obj in (pm, tm, lm):
obj.set_log_level(logging.WARN if options.get("silent") else logging.DEBUG)
for spec in options.get("platforms"):
pm.install(
spec,
skip_default_package=options.get("skip_dependencies"),
force=options.get("force"),
)
for spec in options.get("tools"):
tm.install(
spec,
skip_dependencies=options.get("skip_dependencies"),
force=options.get("force"),
)
for spec in options.get("libraries", []):
lm.install(
spec,
skip_dependencies=options.get("skip_dependencies"),
force=options.get("force"),
)
def install_project_dependencies(options):
environments = options["environments"]
with fs.cd(options["project_dir"]):
config = ProjectConfig.get_instance()
config.validate(environments)
for env in config.envs():
if environments and env not in environments:
continue
if not options["silent"]:
click.echo(
"Resolving %s environment packages..." % click.style(env, fg="cyan")
)
already_up_to_date = install_project_env_dependencies(env, options)
if not options["silent"] and already_up_to_date:
click.secho("Already up-to-date.", fg="green")
def install_project_env_dependencies(project_env, options=None):
"""Used in `pio run` -> Processor"""
options = options or {}
return any(
[
_install_project_env_platform(project_env, options),
_install_project_env_libraries(project_env, options),
]
)
def _install_project_env_platform(project_env, options):
already_up_to_date = not options.get("force")
config = ProjectConfig.get_instance()
pm = PlatformPackageManager()
if options.get("silent"):
pm.set_log_level(logging.WARN)
if options.get("platforms") or options.get("tools"):
already_up_to_date = False
tm = ToolPackageManager()
if not options.get("silent"):
pm.set_log_level(logging.DEBUG)
tm.set_log_level(logging.DEBUG)
for platform in options.get("platforms"):
pm.install(
platform,
project_env=project_env,
project_targets=options.get("project_targets"),
skip_default_package=options.get("skip_dependencies"),
force=options.get("force"),
)
for spec in options.get("tools"):
tm.install(
spec,
skip_dependencies=options.get("skip_dependencies"),
force=options.get("force"),
)
return not already_up_to_date
if options.get("libraries"):
return False
# if not custom libraries, install declared platform
platform = config.get(f"env:{project_env}", "platform")
if platform:
if not pm.get_package(platform):
already_up_to_date = False
PlatformPackageManager().install(
platform,
project_env=project_env,
project_targets=options.get("project_targets"),
skip_default_package=options.get("skip_dependencies"),
force=options.get("force"),
)
return not already_up_to_date
def _install_project_env_libraries(project_env, options):
already_up_to_date = not options.get("force")
config = ProjectConfig.get_instance()
lm = LibraryPackageManager(
os.path.join(config.get("platformio", "libdeps_dir"), project_env)
)
if options.get("silent"):
lm.set_log_level(logging.WARN)
# custom libraries
if options.get("libraries"):
if not options.get("silent"):
lm.set_log_level(logging.DEBUG)
for spec in options.get("libraries", []):
lm.install(
spec,
skip_dependencies=options.get("skip_dependencies"),
force=options.get("force"),
)
return not already_up_to_date
if options.get("platforms") or options.get("tools"):
return False
# if not custom platforms/tools, install declared libraries
for spec in config.get(f"env:{project_env}", "lib_deps"):
# skip built-in dependencies
if "/" not in spec:
continue
if not lm.get_package(spec):
already_up_to_date = False
lm.install(
spec,
skip_dependencies=options.get("skip_dependencies"),
force=options.get("force"),
)
return not already_up_to_date
+2 -1
View File
@@ -47,6 +47,7 @@ class PlatformPackageManager(BasePackageManager): # pylint: disable=too-many-an
with_all_packages=False,
force=False,
project_env=None,
project_targets=None,
):
already_installed = self.get_package(spec)
pkg = super(PlatformPackageManager, self).install(
@@ -63,7 +64,7 @@ class PlatformPackageManager(BasePackageManager): # pylint: disable=too-many-an
p.pm.set_log_level(self.log.getEffectiveLevel())
if project_env:
p.configure_project_packages(project_env)
p.configure_project_packages(project_env, project_targets)
if with_all_packages:
with_packages = list(p.packages)
-9
View File
@@ -65,15 +65,6 @@ class PlatformPackagesMixin(object):
result.append(item)
return result
def autoinstall_required_packages(self):
for name, options in self.packages.items():
if options.get("optional", False):
continue
if self.get_package(name):
continue
self.pm.install(self.get_package_spec(name))
return True
def install_packages( # pylint: disable=too-many-arguments
self,
with_packages=None,
-3
View File
@@ -51,10 +51,7 @@ class PlatformRunMixin(object):
assert isinstance(targets, list)
self.ensure_engine_compatible()
self.configure_project_packages(variables["pioenv"], targets)
self.autoinstall_required_packages()
self._report_non_sensitive_data(variables["pioenv"], targets)
self.silent = silent