plugins.aea-dev-helpers.aea`_`dev`_`helpers.update`_`pkg`_`versions

Updates package versions relative to last release.

This module contains the logic originally in scripts/update_package_versions.py.

Run from the root of the project directory::

aea-dev update-pkg-versions

get`_`protocol`_`specification`_`header`_`regex

def get_protocol_specification_header_regex(public_id) -> Pattern

Get the regex to match.

check`_`positive

def check_positive(value: Any) -> int

Check value is an int.

check`_`if`_`running`_`allowed

def check_if_running_allowed() -> None

Check if we can run the script.

Script should only be run on a clean branch.

run`_`hashing

def run_hashing() -> None

Run the hashing script.

get`_`hashes`_`from`_`last`_`release

def get_hashes_from_last_release() -> Dict[str, str]

Get hashes from last release.

get`_`hashes`_`from`_`current`_`release

def get_hashes_from_current_release() -> Dict[str, str]

Get hashes from last release.

split`_`hashes`_`by`_`type

def split_hashes_by_type(
        all_hashes: Dict[str, str]) -> Dict[str, Dict[str, str]]

Split hashes by type.

get`_`configuration`_`file`_`path

def get_configuration_file_path(type_: str, name: str) -> Path

Get the configuration file path.

unified`_`yaml`_`load

def unified_yaml_load(configuration_file: Path) -> Dict

Load YAML file, unified (both single- and multi-paged).

Arguments:

configuration_file: the configuration file path.

Returns:

the data.

get`_`public`_`id`_`from`_`yaml

def get_public_id_from_yaml(configuration_file_path: Path)

Get the public id from yaml.

Arguments:

configuration_file_path: the path to the config yaml

Returns:

public id

public`_`id`_`in`_`registry

def public_id_in_registry(type_: str, name: str)

Check if a package id is in the registry.

Arguments:

type_: the package type
name: the name of the package

Returns:

public id

get`_`all`_`protocol`_`spec`_`ids

def get_all_protocol_spec_ids() -> Set[PublicId]

Get all protocol specification ids.

We return package ids with type "protocol" even though they are not exactly protocol. The reason is that they are only used to find clashes with protocol ids.

Returns:

a set of package ids.

get`_`all`_`package`_`ids

def get_all_package_ids() -> Set[PackageId]

Get all the package ids in the local repository.

get`_`public`_`ids`_`to`_`update

def get_public_ids_to_update() -> Set[PackageId]

Get all the public ids to be updated.

In particular, a package DOES NOT NEED a version bump if: - the package is a "scaffold" package; - the package is no longer present - the package hasn't change since the last release; - the public ids of the local package and the package in the registry are already the same.

Returns:

set of package ids to update

minor`_`version`_`difference

def minor_version_difference(current_public_id, deployed_public_id) -> int

Check the minor version difference.

replace`_`aea`_`fetch`_`statements

def replace_aea_fetch_statements(content: str, old_string: str,
                                 new_string: str, type_: str) -> str

Replace statements of the type: 'aea fetch '.

replace`_`aea`_`add`_`statements

def replace_aea_add_statements(content: str, old_string: str, new_string: str,
                               type_: str) -> str

Replace statements of the type: 'aea add '.

replace`_`type`_`and`_`public`_`id`_`occurrences

def replace_type_and_public_id_occurrences(line: str, old_string: str,
                                           new_string: str, type_: str) -> str

Replace the public id whenever the type and the id occur in the same row, and NOT when other type names occur.

replace`_`in`_`yamls

def replace_in_yamls(content: str, old_public_id, new_public_id,
                     type_: str) -> str

Replace the public id in configuration files (also nested in .md files).

Arguments:

content: the content
old_public_id: the old public id
new_public_id: the new public id
type_: the type of the package

Returns:

replaced content

replace`_`in`_`protocol`_`readme

def replace_in_protocol_readme(fp: Path, content: str, old_public_id,
                               new_public_id, type_: str) -> str

Replace the version id in the protocol specification in the protcol's README.

That is, bump the version in cases like: |name: package_name |author: package_author |version: package_version -> bump up ...

Arguments:

fp: path to the file being edited.
content: the content of the file.
old_public_id: the old public id.
new_public_id: the new public id.
type_: the type of the package.

Returns:

the new content.

file`_`should`_`be`_`processed

def file_should_be_processed(content: str, old_public_id) -> bool

Check if the file should be processed.

bump`_`version`_`in`_`yaml

def bump_version_in_yaml(configuration_file_path: Path, type_: str,
                         version: str) -> None

Bump the package version in the package yaml.

Updater Objects

class Updater()

Package versions updater tool.

``init``

def __init__(ask_version, update_version, replace_by_default, no_interactive,
             context)

Init updater.

check`_`if`_`svn`_`installed

@staticmethod
def check_if_svn_installed()

Check svn tool installed.

run`_`hashing

@staticmethod
def run_hashing()

Run hashes update.

check`_`if`_`running`_`allowed

@staticmethod
def check_if_running_allowed()

Check if we can run the script.

Script should only be run on a clean branch.

run

def run()

Run package versions update process.

process`_`packages

def process_packages(all_package_ids_to_update: Set[PackageId],
                     ambiguous_public_ids: Set[PublicId]) -> None

Process the package versions.

process`_`package

def process_package(package_id, is_ambiguous: bool) -> None

Process a package.

check version in registry
make sure, version is exactly one above the one in registry
change all occurrences in packages/tests/aea/examples/benchmark/docs to new reference
change yaml version number

Arguments:

package_id: the id of the package
is_ambiguous: whether the public id is ambiguous.

get`_`new`_`package`_`version

def get_new_package_version(current_public_id) -> str

Get new package version according to command line options provided.

bump`_`package`_`version

def bump_package_version(current_public_id,
                         configuration_file_path: Path,
                         type_: str,
                         is_ambiguous: bool = False) -> None

Bump the version references of the package in the repo.

Includes, bumping the package itself.

Arguments:

current_public_id: the current public id
configuration_file_path: the path to the configuration file
type_: the type of package
is_ambiguous: whether or not the package id is ambiguous

inplace`_`change

def inplace_change(fp: Path, old_public_id, new_public_id, type_: str,
                   is_ambiguous: bool) -> None

Replace the occurrence of a string with a new one in the provided file.

command

@click.command(name="update-pkg-versions")
@click.option(
    "--ask-version",
    "-a",
    is_flag=True,
    help="Ask for every package version interactively",
)
@click.option(
    "--update-minor",
    "update_version",
    flag_value="minor",
    default=None,
    help="Increase minor version",
)
@click.option(
    "--update-patch",
    "update_version",
    flag_value="patch",
    default=None,
    help="Increase patch version",
)
@click.option(
    "--no-interactive",
    "-n",
    is_flag=True,
    help="Don't ask user confirmation for replacement.",
)
@click.option(
    "--context",
    "-C",
    type=int,
    help="The number of above/below rows to display.",
    default=3,
)
@click.option(
    "--replace-by-default",
    "-r",
    is_flag=True,
    help="If --no-interactive is set, apply the replacement (default: False).",
)
def command(ask_version, update_version, replace_by_default, no_interactive,
            context)

Update package versions relative to last release.

plugins.aea-dev-helpers.aea_dev_helpers.update_pkg_versions

get_protocol_specification_header_regex

check_positive

check_if_running_allowed

run_hashing

get_hashes_from_last_release

get_hashes_from_current_release

split_hashes_by_type

get_configuration_file_path

unified_yaml_load

get_public_id_from_yaml

public_id_in_registry

get_all_protocol_spec_ids

get_all_package_ids

get_public_ids_to_update

minor_version_difference

replace_aea_fetch_statements

replace_aea_add_statements

replace_type_and_public_id_occurrences

replace_in_yamls

replace_in_protocol_readme

file_should_be_processed

bump_version_in_yaml

Updater Objects

__init__

check_if_svn_installed

run_hashing

check_if_running_allowed

run

process_packages

process_package

get_new_package_version

bump_package_version

inplace_change

command

plugins.aea-dev-helpers.aea`_`dev`_`helpers.update`_`pkg`_`versions

get`_`protocol`_`specification`_`header`_`regex

check`_`positive

check`_`if`_`running`_`allowed

run`_`hashing

get`_`hashes`_`from`_`last`_`release

get`_`hashes`_`from`_`current`_`release

split`_`hashes`_`by`_`type

get`_`configuration`_`file`_`path

unified`_`yaml`_`load

get`_`public`_`id`_`from`_`yaml

public`_`id`_`in`_`registry

get`_`all`_`protocol`_`spec`_`ids

get`_`all`_`package`_`ids

get`_`public`_`ids`_`to`_`update

minor`_`version`_`difference

replace`_`aea`_`fetch`_`statements

replace`_`aea`_`add`_`statements

replace`_`type`_`and`_`public`_`id`_`occurrences

replace`_`in`_`yamls

replace`_`in`_`protocol`_`readme

file`_`should`_`be`_`processed

bump`_`version`_`in`_`yaml

``init``

check`_`if`_`svn`_`installed

run`_`hashing

check`_`if`_`running`_`allowed

process`_`packages

process`_`package

get`_`new`_`package`_`version

bump`_`package`_`version

inplace`_`change