platformio/platformio-core
1
0
Fork 1
mirror of https://github.com/platformio/platformio-core.git synced 2025-07-30 01:57:13 +02:00
Code Issues Packages Projects Releases Wiki Activity

Rename "PackageMetaData" class to "PackageMetadata"

Browse Source
This commit is contained in:
Ivan Kravets
2023-07-11 20:12:20 +03:00
parent abda3edad6
commit a423a4dde4
3 changed files with 14 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
platformio/package/manager/base.py
View File

@ -35,7 +35,7 @@ from platformio.package.manager._update import PackageManagerUpdateMixin
from platformio.package.manifest.parser import ManifestParserFactory from platformio.package.manifest.parser import ManifestParserFactory
from platformio.package.meta import ( from platformio.package.meta import (
PackageItem, PackageItem,
PackageMetaData, PackageMetadata,
PackageSpec, PackageSpec,
PackageType, PackageType,
) )
@ -199,7 +199,7 @@ class BasePackageManager( # pylint: disable=too-many-public-methods,too-many-in
def build_metadata(self, pkg_dir, spec, vcs_revision=None): def build_metadata(self, pkg_dir, spec, vcs_revision=None):
manifest = self.load_manifest(pkg_dir) manifest = self.load_manifest(pkg_dir)
metadata = PackageMetaData( metadata = PackageMetadata(
type=self.pkg_type, type=self.pkg_type,
name=manifest.get("name"), name=manifest.get("name"),
version=manifest.get("version"), version=manifest.get("version"),

8
platformio/package/meta.py
View File

@ -401,7 +401,7 @@ class PackageSpec: # pylint: disable=too-many-instance-attributes
return name return name
class PackageMetaData: class PackageMetadata:
def __init__( # pylint: disable=redefined-builtin def __init__( # pylint: disable=redefined-builtin
self, type, name, version, spec=None self, type, name, version, spec=None
): ):
@ -416,7 +416,7 @@ class PackageMetaData:
def __repr__(self): def __repr__(self):
return ( return (
"PackageMetaData <type={type} name={name} version={version} " "PackageMetadata <type={type} name={name} version={version} "
"spec={spec}".format(**self.as_dict()) "spec={spec}".format(**self.as_dict())
) )
@ -466,7 +466,7 @@ class PackageMetaData:
data["spec"]["uri"] = data["spec"]["url"] data["spec"]["uri"] = data["spec"]["url"]
del data["spec"]["url"] del data["spec"]["url"]
data["spec"] = PackageSpec(**data["spec"]) data["spec"] = PackageSpec(**data["spec"])
return PackageMetaData(**data) return PackageMetadata(**data)
class PackageItem: class PackageItem:
@ -515,7 +515,7 @@ class PackageItem:
for location in self.get_metafile_locations(): for location in self.get_metafile_locations():
manifest_path = os.path.join(location, self.METAFILE_NAME) manifest_path = os.path.join(location, self.METAFILE_NAME)
if os.path.isfile(manifest_path): if os.path.isfile(manifest_path):
return PackageMetaData.load(manifest_path) return PackageMetadata.load(manifest_path)
return None return None
def dump_meta(self): def dump_meta(self):

16
tests/package/test_meta.py
View File

@ -19,7 +19,7 @@ import semantic_version
from platformio.package.meta import ( from platformio.package.meta import (
PackageCompatibility, PackageCompatibility,
PackageMetaData, PackageMetadata,
PackageOutdatedResult, PackageOutdatedResult,
PackageSpec, PackageSpec,
PackageType, PackageType,
@ -229,7 +229,7 @@ def test_spec_as_dependency():
def test_metadata_as_dict(): def test_metadata_as_dict():
metadata = PackageMetaData(PackageType.LIBRARY, "foo", "1.2.3") metadata = PackageMetadata(PackageType.LIBRARY, "foo", "1.2.3")
# test setter # test setter
metadata.version = "0.1.2+12345" metadata.version = "0.1.2+12345"
assert metadata.version == semantic_version.Version("0.1.2+12345") assert metadata.version == semantic_version.Version("0.1.2+12345")
@ -244,7 +244,7 @@ def test_metadata_as_dict():
) )
assert not jsondiff.diff( assert not jsondiff.diff(
PackageMetaData( PackageMetadata(
PackageType.TOOL, PackageType.TOOL,
"toolchain", "toolchain",
"2.0.5", "2.0.5",
@ -267,7 +267,7 @@ def test_metadata_as_dict():
def test_metadata_dump(tmpdir_factory): def test_metadata_dump(tmpdir_factory):
pkg_dir = tmpdir_factory.mktemp("package") pkg_dir = tmpdir_factory.mktemp("package")
metadata = PackageMetaData( metadata = PackageMetadata(
PackageType.TOOL, PackageType.TOOL,
"toolchain", "toolchain",
"2.0.5", "2.0.5",
@ -297,9 +297,9 @@ def test_metadata_load(tmpdir_factory):
pkg_dir = tmpdir_factory.mktemp("package") pkg_dir = tmpdir_factory.mktemp("package")
dst = pkg_dir.join(".piopm") dst = pkg_dir.join(".piopm")
dst.write(contents) dst.write(contents)
metadata = PackageMetaData.load(str(dst)) metadata = PackageMetadata.load(str(dst))
assert metadata.version == semantic_version.Version("0.1.3") assert metadata.version == semantic_version.Version("0.1.3")
assert metadata == PackageMetaData( assert metadata == PackageMetadata(
PackageType.PLATFORM, PackageType.PLATFORM,
"foo", "foo",
"0.1.3", "0.1.3",
@ -307,11 +307,11 @@ def test_metadata_load(tmpdir_factory):
) )
piopm_path = pkg_dir.join(".piopm") piopm_path = pkg_dir.join(".piopm")
metadata = PackageMetaData( metadata = PackageMetadata(
PackageType.LIBRARY, "mylib", version="1.2.3", spec=PackageSpec("mylib") PackageType.LIBRARY, "mylib", version="1.2.3", spec=PackageSpec("mylib")
) )
metadata.dump(str(piopm_path)) metadata.dump(str(piopm_path))
restored_metadata = PackageMetaData.load(str(piopm_path)) restored_metadata = PackageMetadata.load(str(piopm_path))
assert metadata == restored_metadata assert metadata == restored_metadata