-
-**Classes**:
-
-.. autoapisummary::
-
- ape._cli.ApeCLI
-
-
-
-**Functions**:
-
-.. autoapisummary::
-
- ape._cli.display_config
- ape._cli.cli
-
-
-
-**Attributes**:
-
-.. autoapisummary::
-
- ape._cli._DIFFLIB_CUT_OFF
-
-
-
------------
-
-
-.. data:: _DIFFLIB_CUT_OFF
- :annotation: = 0.6
-
-
-
-
-
-.. py:function:: display_config(ctx, param, value)
-
-
-
-
-.. py:class:: ApeCLI(name: Optional[str] = None, invoke_without_command: bool = False, no_args_is_help: Optional[bool] = None, subcommand_metavar: Optional[str] = None, chain: bool = False, result_callback: Optional[Callable[Ellipsis, Any]] = None, **attrs: Any)
-
- Bases: :py:obj:`click.MultiCommand`
-
- A multi command is the basic implementation of a command that
- dispatches to subcommands. The most common version is the
- :class:`Group`.
-
- :param invoke_without_command: this controls how the multi command itself
- is invoked. By default it's only invoked
- if a subcommand is provided.
- :param no_args_is_help: this controls what happens if no arguments are
- provided. This option is enabled by default if
- `invoke_without_command` is disabled or disabled
- if it's enabled. If enabled this will add
- ``--help`` as argument if no arguments are
- passed.
- :param subcommand_metavar: the string that is used in the documentation
- to indicate the subcommand place.
- :param chain: if this is set to `True` chaining of multiple subcommands
- is enabled. This restricts the form of commands in that
- they cannot have optional arguments but it allows
- multiple commands to be chained together.
- :param result_callback: The result callback to attach to this multi
- command. This can be set or changed later with the
- :meth:`result_callback` decorator.
-
- .. attribute:: _commands
-
-
-
-
- .. py:method:: invoke(self, ctx) -> Any
-
- Given a context, this invokes the attached callback (if it exists)
- in the right way.
-
-
- .. py:method:: _suggest_cmd(usage_error)
- :staticmethod:
-
-
- .. py:method:: commands(self) -> Dict
- :property:
-
-
- .. py:method:: list_commands(self, ctx)
-
- Returns a list of subcommand names in the order they should
- appear.
-
-
- .. py:method:: get_command(self, ctx, name)
-
- Given a context and a command name, this returns a
- :class:`Command` object if it exists or returns `None`.
-
-
-
-
-
-.. py:function:: cli(context)
-
-
-
diff --git a/latest/_sources/autoapi/ape/api/accounts/index.rst.txt b/latest/_sources/autoapi/ape/api/accounts/index.rst.txt
deleted file mode 100644
index da3c735cb4..0000000000
--- a/latest/_sources/autoapi/ape/api/accounts/index.rst.txt
+++ /dev/null
@@ -1,171 +0,0 @@
-:mod:`ape.api.accounts`
-=======================
-
-.. py:module:: ape.api.accounts
-
-
-
-
-.. raw:: html
-
-
Module Contents
-
-**Classes**:
-
-.. autoapisummary::
-
- ape.api.accounts.AccountAPI
- ape.api.accounts.AccountContainerAPI
- ape.api.accounts.TestAccountContainerAPI
- ape.api.accounts.TestAccountAPI
-
-
-
-
-
------------
-
-
-.. py:class:: AccountAPI
-
- Bases: :py:obj:`ape.api.address.AddressAPI`
-
- A base address API class. All account-types subclass this type.
-
- .. attribute:: container
- :annotation: :AccountContainerAPI
-
-
-
- .. py:method:: __dir__(self) -> List[str]
-
- Display methods to IPython on ``a.[TAB]`` tab completion.
-
- Returns:
- list[str]: Method names that IPython uses for tab completion.
-
-
- .. py:method:: alias(self) -> Optional[str]
- :property:
-
- Override with whatever alias might want to use, if applicable
-
-
- .. py:method:: sign_message(self, msg: ape.types.SignableMessage) -> Optional[ape.types.MessageSignature]
- :abstractmethod:
-
- Signs the given message.
-
- Args:
- msg (:class:`~eth_account.messages.SignableMessage`): The message to sign.
-
- Returns:
- :class:`~ape.types.signatures.MessageSignature` (optional): The signed message.
-
-
- .. py:method:: sign_transaction(self, txn: ape.api.providers.TransactionAPI) -> Optional[ape.types.TransactionSignature]
- :abstractmethod:
-
- Signs the given transaction.
-
- Args:
- txn (:class:`~ape.api.providers.TransactionAPI`): The transaction to sign.
-
- Returns:
- :class:`~ape.types.signatures.TransactionSignature` (optional): The signed transaction.
-
-
- .. py:method:: call(self, txn: ape.api.providers.TransactionAPI, send_everything: bool = False) -> ape.api.providers.ReceiptAPI
-
-
- .. py:method:: _convert(self) -> Callable
-
-
- .. py:method:: transfer(self, account: Union[str, ape.types.AddressType, ape.api.address.AddressAPI], value: Union[str, int, None] = None, data: Union[bytes, str, None] = None, **kwargs) -> ape.api.providers.ReceiptAPI
-
-
- .. py:method:: deploy(self, contract: ape.contracts.ContractContainer, *args, **kwargs) -> ape.contracts.ContractInstance
-
-
-
-
-
-.. py:class:: AccountContainerAPI
-
- .. attribute:: data_folder
- :annotation: :pathlib.Path
-
-
-
- .. attribute:: account_type
- :annotation: :Type[AccountAPI]
-
-
-
- .. attribute:: config_manager
- :annotation: :ape.managers.config.ConfigManager
-
-
-
- .. py:method:: aliases(self) -> Iterator[str]
- :property:
-
-
- .. py:method:: __len__(self) -> int
- :abstractmethod:
-
-
- .. py:method:: __iter__(self) -> Iterator[AccountAPI]
- :abstractmethod:
-
-
- .. py:method:: __getitem__(self, address: ape.types.AddressType) -> AccountAPI
-
-
- .. py:method:: append(self, account: AccountAPI)
-
-
- .. py:method:: __setitem__(self, address: ape.types.AddressType, account: AccountAPI)
- :abstractmethod:
-
-
- .. py:method:: remove(self, account: AccountAPI)
-
-
- .. py:method:: __delitem__(self, address: ape.types.AddressType)
- :abstractmethod:
-
-
- .. py:method:: __contains__(self, address: ape.types.AddressType) -> bool
-
-
- .. py:method:: _verify_account_type(self, account)
-
-
- .. py:method:: _verify_unused_alias(self, account)
-
-
-
-
-
-.. py:class:: TestAccountContainerAPI
-
- Bases: :py:obj:`AccountContainerAPI`
-
- Test account containers for ``ape test`` should implement
- this API instead of ``AccountContainerAPI`` directly. This
- is how they show up in the ``accounts`` test fixture.
-
-
-
-
-.. py:class:: TestAccountAPI
-
- Bases: :py:obj:`AccountAPI`
-
- Test accounts for ``ape test`` should implement this API
- instead of ``AccountAPI`` directly. This is how they show
- up in the ``accounts`` test fixture.
-
-
-
diff --git a/latest/_sources/autoapi/ape/api/address/index.rst.txt b/latest/_sources/autoapi/ape/api/address/index.rst.txt
deleted file mode 100644
index 4b9c4fa9d5..0000000000
--- a/latest/_sources/autoapi/ape/api/address/index.rst.txt
+++ /dev/null
@@ -1,148 +0,0 @@
-:mod:`ape.api.address`
-======================
-
-.. py:module:: ape.api.address
-
-
-
-
-.. raw:: html
-
-
Module Contents
-
-**Classes**:
-
-.. autoapisummary::
-
- ape.api.address.AddressAPI
- ape.api.address.Address
-
-
-
-
-
------------
-
-
-.. py:class:: AddressAPI
-
- A base address API class. All account-types subclass this type.
-
- .. attribute:: _provider
- :annotation: :Optional[ape.api.providers.ProviderAPI]
-
-
-
- .. py:method:: provider(self) -> ape.api.providers.ProviderAPI
- :property:
-
- The current active provider if connected to one.
- If there is no active provider at runtime, then this raises an
- :class:`~ape.exceptions.AddressError`.
-
- Returns:
- :class:`~ape.api.providers.ProviderAPI`
-
-
- .. py:method:: address(self) -> ape.types.AddressType
- :property:
-
- The address of this account. Subclasses must override and provide this value.
-
- Returns:
- :class:`~ape.types.AddressType`
-
-
- .. py:method:: __dir__(self) -> List[str]
-
- Display methods to IPython on ``a.[TAB]`` tab completion.
-
- Returns:
- list[str]: Method names that IPython uses for tab completion.
-
-
- .. py:method:: __repr__(self) -> str
-
- Return repr(self).
-
-
- .. py:method:: __str__(self) -> str
-
- Convert this class to a ``str`` address.
-
- Returns:
- str: The stringified address.
-
-
- .. py:method:: nonce(self) -> int
- :property:
-
- The number of transactions associated with the address.
-
- Returns:
- int
-
-
- .. py:method:: balance(self) -> int
- :property:
-
- The total balance of the account.
-
- Returns:
- int
-
-
- .. py:method:: code(self) -> bytes
- :property:
-
- The smart-contract code at the address.
-
- Returns:
- bytes: The raw bytes of the contract.
-
-
- .. py:method:: codesize(self) -> int
- :property:
-
- The size of the smart-contract.
-
- Returns:
- int: The number of bytes in the smart contract.
-
-
- .. py:method:: is_contract(self) -> bool
- :property:
-
- ``True`` when there is code associated with the address.
-
- Returns:
- bool
-
-
-
-
-
-.. py:class:: Address
-
- Bases: :py:obj:`AddressAPI`
-
- A generic blockchain address.
- Typically, this is used when we do not know the contract type at a given address,
- or to refer to an EOA the user doesn't personally control.
-
- .. attribute:: _address
- :annotation: :ape.types.AddressType
-
-
-
- .. py:method:: address(self) -> ape.types.AddressType
- :property:
-
- The raw address type.
-
- Returns:
- :class:`~ape.types.AddressType`
-
-
-
-
diff --git a/latest/_sources/autoapi/ape/api/base/index.rst.txt b/latest/_sources/autoapi/ape/api/base/index.rst.txt
deleted file mode 100644
index 09059f346b..0000000000
--- a/latest/_sources/autoapi/ape/api/base/index.rst.txt
+++ /dev/null
@@ -1,47 +0,0 @@
-:mod:`ape.api.base`
-===================
-
-.. py:module:: ape.api.base
-
-
-
-
-.. raw:: html
-
-
-
-**Classes**:
-
-.. autoapisummary::
-
- ape.api.config.ConfigEnum
- ape.api.config.ConfigItem
- ape.api.config.ConfigDict
-
-
-
-
-
------------
-
-
-.. py:class:: ConfigEnum
-
- Bases: :py:obj:`str`, :py:obj:`enum.Enum`
-
- str(object='') -> str
- str(bytes_or_buffer[, encoding[, errors]]) -> str
-
- Create a new string object from the given object. If encoding or
- errors is specified, then the object must expose a data buffer
- that will be decoded using the given encoding and error handler.
- Otherwise, returns the result of object.__str__() (if defined)
- or repr(object).
- encoding defaults to sys.getdefaultencoding().
- errors defaults to 'strict'.
-
-
-
-
-.. py:class:: ConfigItem
-
- Each plugin must inherit from this Config base class
-
- .. py:method:: serialize(self) -> Dict
-
-
- .. py:method:: validate_config(self)
-
-
- .. py:method:: __getitem__(self, attrname: str) -> Any
-
-
-
-
-
-.. py:class:: ConfigDict
-
- Bases: :py:obj:`ConfigItem`
-
- Each plugin must inherit from this Config base class
-
- .. py:method:: __post_init__(self)
-
-
-
-
diff --git a/latest/_sources/autoapi/ape/api/contracts/index.rst.txt b/latest/_sources/autoapi/ape/api/contracts/index.rst.txt
deleted file mode 100644
index 3c2f6e2209..0000000000
--- a/latest/_sources/autoapi/ape/api/contracts/index.rst.txt
+++ /dev/null
@@ -1,324 +0,0 @@
-:mod:`ape.api.contracts`
-========================
-
-.. py:module:: ape.api.contracts
-
-
-
-
-.. raw:: html
-
-
-
-**Classes**:
-
-.. autoapisummary::
-
- ape.api.providers.TransactionType
- ape.api.providers.TransactionAPI
- ape.api.providers.TransactionStatusEnum
- ape.api.providers.ConfirmationsProgressBar
- ape.api.providers.ReceiptAPI
- ape.api.providers.BlockGasAPI
- ape.api.providers.BlockConsensusAPI
- ape.api.providers.BlockAPI
- ape.api.providers.ProviderAPI
- ape.api.providers.TestProviderAPI
- ape.api.providers.Web3Provider
- ape.api.providers.UpstreamProvider
-
-
-
-
-
------------
-
-
-.. py:class:: TransactionType
-
- Bases: :py:obj:`enum.Enum`
-
- Generic enumeration.
-
- Derive from this class to define new enumerations.
-
- .. attribute:: STATIC
- :annotation: = 0x0
-
-
-
- .. attribute:: DYNAMIC
- :annotation: = 0x2
-
-
-
-
-
-
-.. py:class:: TransactionAPI
-
- .. attribute:: chain_id
- :annotation: :int = 0
-
-
-
- .. attribute:: sender
- :annotation: :str =
-
-
-
- .. attribute:: receiver
- :annotation: :str =
-
-
-
- .. attribute:: nonce
- :annotation: :Optional[int]
-
-
-
- .. attribute:: value
- :annotation: :int = 0
-
-
-
- .. attribute:: gas_limit
- :annotation: :Optional[int]
-
-
-
- .. attribute:: data
- :annotation: :bytes = b''
-
-
-
- .. attribute:: type
- :annotation: :TransactionType
-
-
-
- .. attribute:: required_confirmations
- :annotation: :Optional[int]
-
-
-
- .. attribute:: signature
- :annotation: :Optional[ape.types.TransactionSignature]
-
-
-
- .. py:method:: __post_init__(self)
-
-
- .. py:method:: max_fee(self) -> int
- :property:
-
- The total amount in fees willing to be spent on a transaction.
- Override this property as needed, such as for EIP-1559 differences.
-
- See :class:`~ape_ethereum.ecosystem.StaticFeeTransaction` and
- :class`~ape_ethereum.ecosystem.DynamicFeeTransaction` as examples.
-
-
- .. py:method:: total_transfer_value(self) -> int
- :property:
-
- The total amount of WEI that a transaction could use.
- Useful for determining if an account balance can afford
- to submit the transaction.
-
-
- .. py:method:: is_valid(self)
- :property:
-
-
- .. py:method:: encode(self) -> bytes
- :abstractmethod:
-
- Take this object and produce a hash to sign to submit a transaction
-
-
- .. py:method:: as_dict(self) -> dict
-
-
- .. py:method:: __repr__(self) -> str
-
- Return repr(self).
-
-
- .. py:method:: __str__(self) -> str
-
- Return str(self).
-
-
-
-
-
-.. py:class:: TransactionStatusEnum
-
- Bases: :py:obj:`enum.IntEnum`
-
- Enum where members are also (and must be) ints
-
- .. attribute:: FAILING
- :annotation: = 0
-
-
-
- .. attribute:: NO_ERROR
- :annotation: = 1
-
-
-
-
-
-
-.. py:class:: ConfirmationsProgressBar(confirmations: int)
-
- A progress bar tracking the confirmations of a transaction.
-
- .. py:method:: __init__(self, confirmations: int)
-
-
- .. py:method:: __enter__(self)
-
-
- .. py:method:: __exit__(self, exc_type, exc_val, exc_tb)
-
-
- .. py:method:: confs(self) -> int
- :property:
-
-
- .. py:method:: _update_bar(self, amount: int)
-
-
- .. py:method:: _set_description(self)
-
-
-
-
-
-.. py:class:: ReceiptAPI
-
- .. attribute:: provider
- :annotation: :ProviderAPI
-
-
-
- .. attribute:: txn_hash
- :annotation: :str
-
-
-
- .. attribute:: status
- :annotation: :TransactionStatusEnum
-
-
-
- .. attribute:: block_number
- :annotation: :int
-
-
-
- .. attribute:: gas_used
- :annotation: :int
-
-
-
- .. attribute:: gas_price
- :annotation: :int
-
-
-
- .. attribute:: logs
- :annotation: :List[dict] = []
-
-
-
- .. attribute:: contract_address
- :annotation: :Optional[str]
-
-
-
- .. attribute:: required_confirmations
- :annotation: :int = 0
-
-
-
- .. attribute:: sender
- :annotation: :str
-
-
-
- .. attribute:: nonce
- :annotation: :int
-
-
-
- .. py:method:: __post_init__(self)
-
-
- .. py:method:: __str__(self) -> str
-
- Return str(self).
-
-
- .. py:method:: raise_for_status(self, txn: TransactionAPI)
-
- Handle provider-specific errors regarding a non-successful
- :class:`~api.providers.TransactionStatusEnum`.
-
-
- .. py:method:: ran_out_of_gas(self, gas_limit: int) -> bool
-
- Returns ``True`` when the transaction failed and used the
- same amount of gas as the given ``gas_limit``.
-
-
- .. py:method:: decode(cls, data: dict) -> ReceiptAPI
- :classmethod:
- :abstractmethod:
-
-
- .. py:method:: await_confirmations(self) -> ReceiptAPI
-
- Waits for a transaction to be considered confirmed.
- Returns the confirmed receipt.
-
-
-
-
-
-.. py:class:: BlockGasAPI
-
- .. attribute:: gas_limit
- :annotation: :int
-
-
-
- .. attribute:: gas_used
- :annotation: :int
-
-
-
- .. attribute:: base_fee
- :annotation: :Optional[int]
-
-
-
- .. py:method:: decode(cls, data: Dict) -> BlockGasAPI
- :classmethod:
- :abstractmethod:
-
-
-
-
-
-.. py:class:: BlockConsensusAPI
-
- .. attribute:: difficulty
- :annotation: :Optional[int]
-
-
-
- .. attribute:: total_difficulty
- :annotation: :Optional[int]
-
-
-
- .. py:method:: decode(cls, data: Dict) -> BlockConsensusAPI
- :classmethod:
- :abstractmethod:
-
-
-
-
-
-.. py:class:: BlockAPI
-
- .. attribute:: gas_data
- :annotation: :BlockGasAPI
-
-
-
- .. attribute:: consensus_data
- :annotation: :BlockConsensusAPI
-
-
-
- .. attribute:: hash
- :annotation: :hexbytes.HexBytes
-
-
-
- .. attribute:: number
- :annotation: :int
-
-
-
- .. attribute:: parent_hash
- :annotation: :hexbytes.HexBytes
-
-
-
- .. attribute:: size
- :annotation: :int
-
-
-
- .. attribute:: timestamp
- :annotation: :float
-
-
-
- .. py:method:: decode(cls, data: Dict) -> BlockAPI
- :classmethod:
- :abstractmethod:
-
-
-
-
-
-.. py:class:: ProviderAPI
-
- A Provider must work with a particular Network in a particular Ecosystem
-
- .. attribute:: name
- :annotation: :str
-
-
-
- .. attribute:: network
- :annotation: :ape.api.networks.NetworkAPI
-
-
-
- .. attribute:: config
- :annotation: :ape.api.config.ConfigItem
-
-
-
- .. attribute:: provider_settings
- :annotation: :dict
-
-
-
- .. attribute:: data_folder
- :annotation: :pathlib.Path
-
-
-
- .. attribute:: request_header
- :annotation: :str
-
-
-
- .. py:method:: connect(self)
- :abstractmethod:
-
-
- .. py:method:: disconnect(self)
- :abstractmethod:
-
-
- .. py:method:: update_settings(self, new_settings: dict)
- :abstractmethod:
-
-
- .. py:method:: chain_id(self) -> int
- :property:
-
-
- .. py:method:: get_balance(self, address: str) -> int
- :abstractmethod:
-
-
- .. py:method:: get_code(self, address: str) -> bytes
- :abstractmethod:
-
-
- .. py:method:: get_nonce(self, address: str) -> int
- :abstractmethod:
-
-
- .. py:method:: estimate_gas_cost(self, txn: TransactionAPI) -> int
- :abstractmethod:
-
-
- .. py:method:: gas_price(self) -> int
- :property:
-
-
- .. py:method:: priority_fee(self) -> int
- :property:
-
-
- .. py:method:: base_fee(self) -> int
- :property:
-
-
- .. py:method:: get_block(self, block_id: ape.types.BlockID) -> BlockAPI
- :abstractmethod:
-
-
- .. py:method:: send_call(self, txn: TransactionAPI) -> bytes
- :abstractmethod:
-
-
- .. py:method:: get_transaction(self, txn_hash: str) -> ReceiptAPI
- :abstractmethod:
-
-
- .. py:method:: send_transaction(self, txn: TransactionAPI) -> ReceiptAPI
- :abstractmethod:
-
-
- .. py:method:: get_events(self, **filter_params) -> Iterator[dict]
- :abstractmethod:
-
-
-
-
-
-.. py:class:: TestProviderAPI
-
- Bases: :py:obj:`ProviderAPI`
-
- An API for providers that have development functionality, such as snapshotting.
-
- .. py:method:: snapshot(self) -> str
- :abstractmethod:
-
-
- .. py:method:: revert(self, snapshot_id: str)
- :abstractmethod:
-
-
-
-
-
-.. py:class:: Web3Provider
-
- Bases: :py:obj:`ProviderAPI`
-
- A base provider that is web3 based.
-
- .. attribute:: _web3
- :annotation: :web3.Web3
-
-
-
- .. py:method:: update_settings(self, new_settings: dict)
-
- Update the provider settings and re-connect.
-
-
- .. py:method:: estimate_gas_cost(self, txn: TransactionAPI) -> int
-
- Generates and returns an estimate of how much gas is necessary
- to allow the transaction to complete.
- The transaction will not be added to the blockchain.
-
-
- .. py:method:: chain_id(self) -> int
- :property:
-
- Returns the currently configured chain ID,
- a value used in replay-protected transaction signing as introduced by EIP-155.
-
-
- .. py:method:: gas_price(self) -> int
- :property:
-
- Returns the current price per gas in wei.
-
-
- .. py:method:: priority_fee(self) -> int
- :property:
-
- Returns the current max priority fee per gas in wei.
-
-
- .. py:method:: base_fee(self) -> int
- :property:
-
- Returns the current base fee from the latest block.
-
- NOTE: If your chain does not support base_fees (EIP-1559),
- this method will raise a not-implemented error.
-
-
- .. py:method:: get_block(self, block_id: ape.types.BlockID) -> BlockAPI
-
- Returns a block for the given ID.
-
- Args:
- block_id: The ID of the block to get. Set as
- "latest" to get the latest block,
- "earliest" to get the earliest block,
- "pending" to get the pending block,
- or pass in a block number or hash.
-
- Returns:
- The block for the given block ID.
-
-
- .. py:method:: get_nonce(self, address: str) -> int
-
- Returns the number of transactions sent from an address.
-
-
- .. py:method:: get_balance(self, address: str) -> int
-
- Returns the balance of the account of a given address.
-
-
- .. py:method:: get_code(self, address: str) -> bytes
-
- Returns code at a given address.
-
-
- .. py:method:: send_call(self, txn: TransactionAPI) -> bytes
-
- Executes a new message call immediately without creating a
- transaction on the block chain.
-
-
- .. py:method:: get_transaction(self, txn_hash: str, required_confirmations: int = 0) -> ReceiptAPI
-
- Returns the information about a transaction requested by transaction hash.
-
- Params:
- txn_hash (str): The hash of the transaction to retrieve.
- required_confirmations (int): If more than 0, waits for that many
- confirmations before returning the receipt. This is to increase confidence
- that your transaction is in its final position on the blockchain. Defaults
- to 0.
-
- Returns:
- The receipt of the transaction with the given hash.
-
-
- .. py:method:: get_events(self, **filter_params) -> Iterator[dict]
-
- Returns an array of all logs matching a given set of filter parameters.
-
-
- .. py:method:: send_transaction(self, txn: TransactionAPI) -> ReceiptAPI
-
-
-
-
-
-.. py:class:: UpstreamProvider
-
- Bases: :py:obj:`ProviderAPI`
-
- A provider that can also be set as another provider's upstream.
-
- .. py:method:: connection_str(self) -> str
- :property:
-
- The str used by downstream providers to connect to this one.
- For example, the URL for HTTP-based providers.
-
-
-
-
diff --git a/latest/_sources/autoapi/ape/cli/arguments/index.rst.txt b/latest/_sources/autoapi/ape/cli/arguments/index.rst.txt
deleted file mode 100644
index 90d1d53681..0000000000
--- a/latest/_sources/autoapi/ape/cli/arguments/index.rst.txt
+++ /dev/null
@@ -1,81 +0,0 @@
-:mod:`ape.cli.arguments`
-========================
-
-.. py:module:: ape.cli.arguments
-
-
-
-
-.. raw:: html
-
-
Module Contents
-
-
-**Functions**:
-
-.. autoapisummary::
-
- ape.cli.arguments._require_non_existing_alias
- ape.cli.arguments.existing_alias_argument
- ape.cli.arguments.non_existing_alias_argument
- ape.cli.arguments._create_contracts_paths
- ape.cli.arguments.contract_file_paths_argument
-
-
-
-**Attributes**:
-
-.. autoapisummary::
-
- ape.cli.arguments._flatten
-
-
-
------------
-
-
-.. data:: _flatten
-
-
-
-
-
-
-.. py:function:: _require_non_existing_alias(value)
-
-
-
-
-.. py:function:: existing_alias_argument(account_type: Optional[Type[ape.api.AccountAPI]] = None)
-
- A ``click.argument`` for an existing account alias.
-
- Args:
- account_type (type[:class:`~ape.api.accounts.AccountAPI`], optional):
- If given, limits the type of account the user may choose from.
-
-
-
-
-.. py:function:: non_existing_alias_argument()
-
- A ``click.argument`` for an account alias that does not yet exist in ape.
-
-
-
-
-.. py:function:: _create_contracts_paths(ctx, param, value)
-
-
-
-
-.. py:function:: contract_file_paths_argument()
-
- A ``click.argument`` representing contract source file paths.
- This argument takes 0-to-many values.
-
- The return type from the callback is a flattened list of
- source file-paths.
-
-
-
diff --git a/latest/_sources/autoapi/ape/cli/choices/index.rst.txt b/latest/_sources/autoapi/ape/cli/choices/index.rst.txt
deleted file mode 100644
index 7062cc6fda..0000000000
--- a/latest/_sources/autoapi/ape/cli/choices/index.rst.txt
+++ /dev/null
@@ -1,240 +0,0 @@
-:mod:`ape.cli.choices`
-======================
-
-.. py:module:: ape.cli.choices
-
-
-
-
-.. raw:: html
-
-
Module Contents
-
-**Classes**:
-
-.. autoapisummary::
-
- ape.cli.choices.Alias
- ape.cli.choices.PromptChoice
- ape.cli.choices.AccountAliasPromptChoice
- ape.cli.choices.NetworkChoice
- ape.cli.choices.OutputFormat
-
-
-
-**Functions**:
-
-.. autoapisummary::
-
- ape.cli.choices._get_account_by_type
- ape.cli.choices.get_user_selected_account
- ape.cli.choices.output_format_choice
-
-
-
-
------------
-
-
-.. py:function:: _get_account_by_type(account_type: Optional[Type[ape.api.accounts.AccountAPI]] = None) -> List[ape.api.accounts.AccountAPI]
-
-
-
-
-.. py:class:: Alias(account_type: Optional[Type[ape.api.accounts.AccountAPI]] = None)
-
- Bases: :py:obj:`click.Choice`
-
- A ``click.Choice`` for loading account aliases for the active project at runtime.
-
- Provide an ``account_type`` to limit the type of account to choose from.
- Defaults to all account types in ``choices()``.
-
- .. attribute:: name
- :annotation: = alias
-
-
-
- .. py:method:: __init__(self, account_type: Optional[Type[ape.api.accounts.AccountAPI]] = None)
-
-
- .. py:method:: choices(self) -> List[str]
- :property:
-
- The aliases available to choose from.
-
- Returns:
- list[str]: A list of account aliases the user may choose from.
-
-
-
-
-
-.. py:class:: PromptChoice(choices)
-
- Bases: :py:obj:`click.ParamType`
-
- A choice option or argument from user selection.
-
- .. py:method:: __init__(self, choices)
-
-
- .. py:method:: print_choices(self)
-
- Echo the choices to the terminal.
-
-
- .. py:method:: convert(self, value: Any, param: Optional[click.Parameter], ctx: Optional[click.Context]) -> Optional[Any]
-
- Convert the value to the correct type. This is not called if
- the value is ``None`` (the missing value).
-
- This must accept string values from the command line, as well as
- values that are already the correct type. It may also convert
- other compatible types.
-
- The ``param`` and ``ctx`` arguments may be ``None`` in certain
- situations, such as when converting prompt input.
-
- If the value cannot be converted, call :meth:`fail` with a
- descriptive message.
-
- :param value: The value to convert.
- :param param: The parameter that is using this type to convert
- its value. May be ``None``.
- :param ctx: The current context that arrived at this value. May
- be ``None``.
-
-
- .. py:method:: fail_from_invalid_choice(self, param)
-
-
-
-
-
-.. py:function:: get_user_selected_account(account_type: Optional[Type[ape.api.accounts.AccountAPI]] = None, prompt_message: Optional[str] = None) -> ape.api.accounts.AccountAPI
-
- Prompt the user to pick from their accounts and return that account.
- Use this method if you want to prompt users to select accounts _outside_
- of CLI options. For CLI options, use
- :meth:`~ape.cli.options.account_option_that_prompts_when_not_given`.
-
- Args:
- account_type (type[:class:`~ape.api.accounts.AccountAPI`], optional):
- If given, the user may only select an account of this type.
- prompt_message (str, optional): Customize the prompt message.
-
- Returns:
- :class:`~ape.api.accounts.AccountAPI`
-
-
-
-
-.. py:class:: AccountAliasPromptChoice(account_type: Optional[Type[ape.api.accounts.AccountAPI]] = None, prompt_message: str = None)
-
- Bases: :py:obj:`PromptChoice`
-
- Prompts the user to select an alias from their accounts.
- Useful for adhoc scripts to lessen the need to hard-code aliases.
-
- .. py:method:: __init__(self, account_type: Optional[Type[ape.api.accounts.AccountAPI]] = None, prompt_message: str = None)
-
-
- .. py:method:: convert(self, value: Any, param: Optional[click.Parameter], ctx: Optional[click.Context]) -> Optional[ape.api.accounts.AccountAPI]
-
- Convert the value to the correct type. This is not called if
- the value is ``None`` (the missing value).
-
- This must accept string values from the command line, as well as
- values that are already the correct type. It may also convert
- other compatible types.
-
- The ``param`` and ``ctx`` arguments may be ``None`` in certain
- situations, such as when converting prompt input.
-
- If the value cannot be converted, call :meth:`fail` with a
- descriptive message.
-
- :param value: The value to convert.
- :param param: The parameter that is using this type to convert
- its value. May be ``None``.
- :param ctx: The current context that arrived at this value. May
- be ``None``.
-
-
- .. py:method:: choices(self) -> List[str]
- :property:
-
- All the account aliases.
-
- Returns:
- list[str]: A list of all the account aliases.
-
-
- .. py:method:: get_user_selected_account(self) -> ape.api.accounts.AccountAPI
-
- Returns the selected account.
-
- Returns:
- :class:`~ape.api.accounts.AccountAPI`
-
-
- .. py:method:: fail_from_invalid_choice(self, param)
-
-
-
-
-
-.. py:class:: NetworkChoice(case_sensitive=True)
-
- Bases: :py:obj:`click.Choice`
-
- A ``click.Choice`` to provide network choice defaults for the active project.
-
- .. py:method:: __init__(self, case_sensitive=True)
-
-
- .. py:method:: get_metavar(self, param)
-
- Returns the metavar default for this param if it provides one.
-
-
-
-
-
-.. py:class:: OutputFormat
-
- Bases: :py:obj:`enum.Enum`
-
- An enum representing output formats, such as ``TREE`` or ``YAML``.
- Use this to select a subset of common output formats to use
- when creating a :meth:`~ape.cli.choices.output_format_choice`.
-
- .. attribute:: TREE
- :annotation: = TREE
-
- A rich text tree view of the data.
-
-
- .. attribute:: YAML
- :annotation: = YAML
-
- A standard .yaml format of the data.
-
-
-
-
-
-.. py:function:: output_format_choice(options: List[OutputFormat] = None) -> click.Choice
-
- Returns a ``click.Choice()`` type for the given options.
-
- Args:
- options (list[:class:`~ape.choices.OutputFormat`], optional):
- Limit the formats to accept. Defaults to allowing all formats.
-
- Returns:
- :class:`click.Choice`
-
-
-
diff --git a/latest/_sources/autoapi/ape/cli/commands/index.rst.txt b/latest/_sources/autoapi/ape/cli/commands/index.rst.txt
deleted file mode 100644
index b908d55b7a..0000000000
--- a/latest/_sources/autoapi/ape/cli/commands/index.rst.txt
+++ /dev/null
@@ -1,40 +0,0 @@
-:mod:`ape.cli.commands`
-=======================
-
-.. py:module:: ape.cli.commands
-
-
-
-
-.. raw:: html
-
-
Module Contents
-
-**Classes**:
-
-.. autoapisummary::
-
- ape.cli.commands.NetworkBoundCommand
-
-
-
-
-
------------
-
-
-.. py:class:: NetworkBoundCommand(name: Optional[str], context_settings: Optional[Dict[str, Any]] = None, callback: Optional[Callable[Ellipsis, Any]] = None, params: Optional[List[Parameter]] = None, help: Optional[str] = None, epilog: Optional[str] = None, short_help: Optional[str] = None, options_metavar: Optional[str] = '[OPTIONS]', add_help_option: bool = True, no_args_is_help: bool = False, hidden: bool = False, deprecated: bool = False)
-
- Bases: :py:obj:`click.Command`
-
- A command that uses the :meth:`~ape.cli.options.network_option`.
- It will automatically set the network for the duration of the command execution.
-
- .. py:method:: invoke(self, ctx: click.Context) -> Any
-
- Given a context, this invokes the attached callback (if it exists)
- in the right way.
-
-
-
-
diff --git a/latest/_sources/autoapi/ape/cli/index.rst.txt b/latest/_sources/autoapi/ape/cli/index.rst.txt
deleted file mode 100644
index a0e6a3bdc8..0000000000
--- a/latest/_sources/autoapi/ape/cli/index.rst.txt
+++ /dev/null
@@ -1,413 +0,0 @@
-:mod:`ape.cli`
-==============
-
-.. py:module:: ape.cli
-
-
-
-.. raw:: html
-
-
-
-**Classes**:
-
-.. autoapisummary::
-
- ape.cli.AccountAliasPromptChoice
- ape.cli.Alias
- ape.cli.OutputFormat
- ape.cli.PromptChoice
- ape.cli.NetworkBoundCommand
- ape.cli.AllFilePaths
- ape.cli.Path
-
-
-
-**Functions**:
-
-.. autoapisummary::
-
- ape.cli.contract_file_paths_argument
- ape.cli.existing_alias_argument
- ape.cli.non_existing_alias_argument
- ape.cli.get_user_selected_account
- ape.cli.output_format_choice
- ape.cli.account_option_that_prompts_when_not_given
- ape.cli.ape_cli_context
- ape.cli.contract_option
- ape.cli.network_option
- ape.cli.output_format_option
- ape.cli.skip_confirmation_option
-
-
-
-
------------
-
-
-.. py:function:: contract_file_paths_argument()
-
- A ``click.argument`` representing contract source file paths.
- This argument takes 0-to-many values.
-
- The return type from the callback is a flattened list of
- source file-paths.
-
-
-
-
-.. py:function:: existing_alias_argument(account_type: Optional[Type[ape.api.AccountAPI]] = None)
-
- A ``click.argument`` for an existing account alias.
-
- Args:
- account_type (type[:class:`~ape.api.accounts.AccountAPI`], optional):
- If given, limits the type of account the user may choose from.
-
-
-
-
-.. py:function:: non_existing_alias_argument()
-
- A ``click.argument`` for an account alias that does not yet exist in ape.
-
-
-
-
-.. py:class:: AccountAliasPromptChoice(account_type: Optional[Type[ape.api.accounts.AccountAPI]] = None, prompt_message: str = None)
-
- Bases: :py:obj:`PromptChoice`
-
- Prompts the user to select an alias from their accounts.
- Useful for adhoc scripts to lessen the need to hard-code aliases.
-
- .. py:method:: __init__(self, account_type: Optional[Type[ape.api.accounts.AccountAPI]] = None, prompt_message: str = None)
-
-
- .. py:method:: convert(self, value: Any, param: Optional[click.Parameter], ctx: Optional[click.Context]) -> Optional[ape.api.accounts.AccountAPI]
-
- Convert the value to the correct type. This is not called if
- the value is ``None`` (the missing value).
-
- This must accept string values from the command line, as well as
- values that are already the correct type. It may also convert
- other compatible types.
-
- The ``param`` and ``ctx`` arguments may be ``None`` in certain
- situations, such as when converting prompt input.
-
- If the value cannot be converted, call :meth:`fail` with a
- descriptive message.
-
- :param value: The value to convert.
- :param param: The parameter that is using this type to convert
- its value. May be ``None``.
- :param ctx: The current context that arrived at this value. May
- be ``None``.
-
-
- .. py:method:: choices(self) -> List[str]
- :property:
-
- All the account aliases.
-
- Returns:
- list[str]: A list of all the account aliases.
-
-
- .. py:method:: get_user_selected_account(self) -> ape.api.accounts.AccountAPI
-
- Returns the selected account.
-
- Returns:
- :class:`~ape.api.accounts.AccountAPI`
-
-
- .. py:method:: fail_from_invalid_choice(self, param)
-
-
-
-
-
-.. py:class:: Alias(account_type: Optional[Type[ape.api.accounts.AccountAPI]] = None)
-
- Bases: :py:obj:`click.Choice`
-
- A ``click.Choice`` for loading account aliases for the active project at runtime.
-
- Provide an ``account_type`` to limit the type of account to choose from.
- Defaults to all account types in ``choices()``.
-
- .. attribute:: name
- :annotation: = alias
-
-
-
- .. py:method:: __init__(self, account_type: Optional[Type[ape.api.accounts.AccountAPI]] = None)
-
-
- .. py:method:: choices(self) -> List[str]
- :property:
-
- The aliases available to choose from.
-
- Returns:
- list[str]: A list of account aliases the user may choose from.
-
-
-
-
-
-.. py:class:: OutputFormat
-
- Bases: :py:obj:`enum.Enum`
-
- An enum representing output formats, such as ``TREE`` or ``YAML``.
- Use this to select a subset of common output formats to use
- when creating a :meth:`~ape.cli.choices.output_format_choice`.
-
- .. attribute:: TREE
- :annotation: = TREE
-
- A rich text tree view of the data.
-
-
- .. attribute:: YAML
- :annotation: = YAML
-
- A standard .yaml format of the data.
-
-
-
-
-
-.. py:class:: PromptChoice(choices)
-
- Bases: :py:obj:`click.ParamType`
-
- A choice option or argument from user selection.
-
- .. py:method:: __init__(self, choices)
-
-
- .. py:method:: print_choices(self)
-
- Echo the choices to the terminal.
-
-
- .. py:method:: convert(self, value: Any, param: Optional[click.Parameter], ctx: Optional[click.Context]) -> Optional[Any]
-
- Convert the value to the correct type. This is not called if
- the value is ``None`` (the missing value).
-
- This must accept string values from the command line, as well as
- values that are already the correct type. It may also convert
- other compatible types.
-
- The ``param`` and ``ctx`` arguments may be ``None`` in certain
- situations, such as when converting prompt input.
-
- If the value cannot be converted, call :meth:`fail` with a
- descriptive message.
-
- :param value: The value to convert.
- :param param: The parameter that is using this type to convert
- its value. May be ``None``.
- :param ctx: The current context that arrived at this value. May
- be ``None``.
-
-
- .. py:method:: fail_from_invalid_choice(self, param)
-
-
-
-
-
-.. py:function:: get_user_selected_account(account_type: Optional[Type[ape.api.accounts.AccountAPI]] = None, prompt_message: Optional[str] = None) -> ape.api.accounts.AccountAPI
-
- Prompt the user to pick from their accounts and return that account.
- Use this method if you want to prompt users to select accounts _outside_
- of CLI options. For CLI options, use
- :meth:`~ape.cli.options.account_option_that_prompts_when_not_given`.
-
- Args:
- account_type (type[:class:`~ape.api.accounts.AccountAPI`], optional):
- If given, the user may only select an account of this type.
- prompt_message (str, optional): Customize the prompt message.
-
- Returns:
- :class:`~ape.api.accounts.AccountAPI`
-
-
-
-
-.. py:function:: output_format_choice(options: List[OutputFormat] = None) -> click.Choice
-
- Returns a ``click.Choice()`` type for the given options.
-
- Args:
- options (list[:class:`~ape.choices.OutputFormat`], optional):
- Limit the formats to accept. Defaults to allowing all formats.
-
- Returns:
- :class:`click.Choice`
-
-
-
-
-.. py:class:: NetworkBoundCommand(name: Optional[str], context_settings: Optional[Dict[str, Any]] = None, callback: Optional[Callable[Ellipsis, Any]] = None, params: Optional[List[Parameter]] = None, help: Optional[str] = None, epilog: Optional[str] = None, short_help: Optional[str] = None, options_metavar: Optional[str] = '[OPTIONS]', add_help_option: bool = True, no_args_is_help: bool = False, hidden: bool = False, deprecated: bool = False)
-
- Bases: :py:obj:`click.Command`
-
- A command that uses the :meth:`~ape.cli.options.network_option`.
- It will automatically set the network for the duration of the command execution.
-
- .. py:method:: invoke(self, ctx: click.Context) -> Any
-
- Given a context, this invokes the attached callback (if it exists)
- in the right way.
-
-
-
-
-
-.. py:function:: account_option_that_prompts_when_not_given()
-
- Accepts either the account alias or the account number.
- If not given anything, it will prompt the user to select an account.
-
-
-
-
-.. py:function:: ape_cli_context()
-
- A ``click`` context object with helpful utilities.
- Use in your commands to get access to common utility features,
- such as logging or accessing managers.
-
-
-
-
-.. py:function:: contract_option(help=None, required=False, multiple=False)
-
- Contract(s) from the current project.
- If you pass ``multiple=True``, you will get a list of contract types from the callback.
-
-
-
-
-.. py:function:: network_option(default: str = networks.default_ecosystem.name)
-
- A ``click.option`` for specifying a network.
-
- Args:
- default (str): Optionally, change which network to
- use as the default. Defaults to how ``ape`` normally
- selects a default network.
-
-
-
-
-.. py:function:: output_format_option(default: ape.cli.choices.OutputFormat = OutputFormat.TREE)
-
- A ``click.option`` for specifying a format to use when outputting data.
-
- Args:
- default (:class:`~ape.cli.choices.OutputFormat`): Defaults to ``TREE`` format.
-
-
-
-
-.. py:function:: skip_confirmation_option(help='')
-
- A ``click.option`` for skipping confirmation (``--yes``).
-
- Args:
- help (str): CLI option help text. Defaults to ``""``.
-
-
-
-
-.. py:class:: AllFilePaths(*args, **kwargs)
-
- Bases: :py:obj:`Path`
-
- Either all the file paths in the given directory,
- or a list containing only the given file.
-
- .. py:method:: convert(self, value: Any, param: Optional[click.Parameter], ctx: Optional[click.Context]) -> List[pathlib.Path]
-
- Convert the value to the correct type. This is not called if
- the value is ``None`` (the missing value).
-
- This must accept string values from the command line, as well as
- values that are already the correct type. It may also convert
- other compatible types.
-
- The ``param`` and ``ctx`` arguments may be ``None`` in certain
- situations, such as when converting prompt input.
-
- If the value cannot be converted, call :meth:`fail` with a
- descriptive message.
-
- :param value: The value to convert.
- :param param: The parameter that is using this type to convert
- its value. May be ``None``.
- :param ctx: The current context that arrived at this value. May
- be ``None``.
-
-
-
-
-
-.. py:class:: Path(*args, **kwargs)
-
- Bases: :py:obj:`click.Path`
-
- This class exists to encourage the consistent usage
- of ``pathlib.Path`` for path_type.
-
- .. py:method:: __init__(self, *args, **kwargs)
-
-
-
-
-
-.. py:exception:: Abort(message)
-
- Bases: :py:obj:`click.ClickException`
-
- A wrapper around a CLI exception. When you raise this error,
- the error is nicely printed to the terminal. This is
- useful for all user-facing errors.
-
- .. py:method:: __init__(self, message)
-
- Initialize self. See help(type(self)) for accurate signature.
-
-
- .. py:method:: show(self, file=None)
-
- Override default ``show`` to print CLI errors in red text.
-
-
-
-
diff --git a/latest/_sources/autoapi/ape/cli/options/index.rst.txt b/latest/_sources/autoapi/ape/cli/options/index.rst.txt
deleted file mode 100644
index a6748dd78b..0000000000
--- a/latest/_sources/autoapi/ape/cli/options/index.rst.txt
+++ /dev/null
@@ -1,147 +0,0 @@
-:mod:`ape.cli.options`
-======================
-
-.. py:module:: ape.cli.options
-
-
-
-
-.. raw:: html
-
-
Module Contents
-
-**Classes**:
-
-.. autoapisummary::
-
- ape.cli.options.ApeCliContextObject
-
-
-
-**Functions**:
-
-.. autoapisummary::
-
- ape.cli.options.verbosity_option
- ape.cli.options.ape_cli_context
- ape.cli.options.network_option
- ape.cli.options.skip_confirmation_option
- ape.cli.options._account_callback
- ape.cli.options.account_option_that_prompts_when_not_given
- ape.cli.options._load_contracts
- ape.cli.options.contract_option
- ape.cli.options.output_format_option
-
-
-
-
------------
-
-
-.. py:class:: ApeCliContextObject
-
- A ``click`` context object class. Use via :meth:`~ape.cli.options.ape_cli_context()`.
- It provides common CLI utilities for ape, such as logging or
- access to the managers.
-
- .. py:method:: __init__(self)
-
-
- .. py:method:: project(self) -> ape.managers.project.ProjectManager
- :property:
-
- A class representing the project that is active at runtime.
- (This is the same object as from ``from ape import project``).
-
- Returns:
- :class:`~ape.managers.project.ProjectManager`
-
-
- .. py:method:: abort(msg: str, base_error: Exception = None)
- :staticmethod:
-
- End execution of the current command invocation.
-
- Args:
- msg (str): A message to output to the terminal.
- base_error (Exception, optional): Optionally provide
- an error to preserve the exception stack.
-
-
-
-
-
-.. py:function:: verbosity_option(cli_logger)
-
- A decorator that adds a `--verbosity, -v` option to the decorated
- command.
-
-
-
-
-.. py:function:: ape_cli_context()
-
- A ``click`` context object with helpful utilities.
- Use in your commands to get access to common utility features,
- such as logging or accessing managers.
-
-
-
-
-.. py:function:: network_option(default: str = networks.default_ecosystem.name)
-
- A ``click.option`` for specifying a network.
-
- Args:
- default (str): Optionally, change which network to
- use as the default. Defaults to how ``ape`` normally
- selects a default network.
-
-
-
-
-.. py:function:: skip_confirmation_option(help='')
-
- A ``click.option`` for skipping confirmation (``--yes``).
-
- Args:
- help (str): CLI option help text. Defaults to ``""``.
-
-
-
-
-.. py:function:: _account_callback(ctx, param, value)
-
-
-
-
-.. py:function:: account_option_that_prompts_when_not_given()
-
- Accepts either the account alias or the account number.
- If not given anything, it will prompt the user to select an account.
-
-
-
-
-.. py:function:: _load_contracts(ctx, param, value) -> Optional[Union[ape.types.ContractType, List[ape.types.ContractType]]]
-
-
-
-
-.. py:function:: contract_option(help=None, required=False, multiple=False)
-
- Contract(s) from the current project.
- If you pass ``multiple=True``, you will get a list of contract types from the callback.
-
-
-
-
-.. py:function:: output_format_option(default: ape.cli.choices.OutputFormat = OutputFormat.TREE)
-
- A ``click.option`` for specifying a format to use when outputting data.
-
- Args:
- default (:class:`~ape.cli.choices.OutputFormat`): Defaults to ``TREE`` format.
-
-
-
diff --git a/latest/_sources/autoapi/ape/cli/paramtype/index.rst.txt b/latest/_sources/autoapi/ape/cli/paramtype/index.rst.txt
deleted file mode 100644
index e9213dc0c1..0000000000
--- a/latest/_sources/autoapi/ape/cli/paramtype/index.rst.txt
+++ /dev/null
@@ -1,70 +0,0 @@
-:mod:`ape.cli.paramtype`
-========================
-
-.. py:module:: ape.cli.paramtype
-
-
-
-
-.. raw:: html
-
-
Module Contents
-
-**Classes**:
-
-.. autoapisummary::
-
- ape.cli.paramtype.Path
- ape.cli.paramtype.AllFilePaths
-
-
-
-
-
------------
-
-
-.. py:class:: Path(*args, **kwargs)
-
- Bases: :py:obj:`click.Path`
-
- This class exists to encourage the consistent usage
- of ``pathlib.Path`` for path_type.
-
- .. py:method:: __init__(self, *args, **kwargs)
-
-
-
-
-
-.. py:class:: AllFilePaths(*args, **kwargs)
-
- Bases: :py:obj:`Path`
-
- Either all the file paths in the given directory,
- or a list containing only the given file.
-
- .. py:method:: convert(self, value: Any, param: Optional[click.Parameter], ctx: Optional[click.Context]) -> List[pathlib.Path]
-
- Convert the value to the correct type. This is not called if
- the value is ``None`` (the missing value).
-
- This must accept string values from the command line, as well as
- values that are already the correct type. It may also convert
- other compatible types.
-
- The ``param`` and ``ctx`` arguments may be ``None`` in certain
- situations, such as when converting prompt input.
-
- If the value cannot be converted, call :meth:`fail` with a
- descriptive message.
-
- :param value: The value to convert.
- :param param: The parameter that is using this type to convert
- its value. May be ``None``.
- :param ctx: The current context that arrived at this value. May
- be ``None``.
-
-
-
-
diff --git a/latest/_sources/autoapi/ape/cli/utils/index.rst.txt b/latest/_sources/autoapi/ape/cli/utils/index.rst.txt
deleted file mode 100644
index 09bc2d5bfc..0000000000
--- a/latest/_sources/autoapi/ape/cli/utils/index.rst.txt
+++ /dev/null
@@ -1,36 +0,0 @@
-:mod:`ape.cli.utils`
-====================
-
-.. py:module:: ape.cli.utils
-
-
-
-
-.. raw:: html
-
-
Module Contents
-
-
------------
-
-
-.. py:exception:: Abort(message)
-
- Bases: :py:obj:`click.ClickException`
-
- A wrapper around a CLI exception. When you raise this error,
- the error is nicely printed to the terminal. This is
- useful for all user-facing errors.
-
- .. py:method:: __init__(self, message)
-
- Initialize self. See help(type(self)) for accurate signature.
-
-
- .. py:method:: show(self, file=None)
-
- Override default ``show`` to print CLI errors in red text.
-
-
-
-
diff --git a/latest/_sources/autoapi/ape/contracts/base/index.rst.txt b/latest/_sources/autoapi/ape/contracts/base/index.rst.txt
deleted file mode 100644
index 7dbbdaf117..0000000000
--- a/latest/_sources/autoapi/ape/contracts/base/index.rst.txt
+++ /dev/null
@@ -1,336 +0,0 @@
-:mod:`ape.contracts.base`
-=========================
-
-.. py:module:: ape.contracts.base
-
-
-
-
-.. raw:: html
-
-
-
-**Classes**:
-
-.. autoapisummary::
-
- ape.managers.converters.HexConverter
- ape.managers.converters.AddressAPIConverter
- ape.managers.converters.HexAddressConverter
- ape.managers.converters.ConversionManager
-
-
-
-
-**Attributes**:
-
-.. autoapisummary::
-
- ape.managers.converters.hex_converter
- ape.managers.converters.address_api_converter
- ape.managers.converters.hex_address_converter
-
-
-
------------
-
-
-.. py:class:: HexConverter
-
- Bases: :py:obj:`ape.api.ConverterAPI`
-
- Abstract base class for generic types.
-
- A generic type is typically declared by inheriting from
- this class parameterized with one or more type variables.
- For example, a generic mapping type might be defined as::
-
- class Mapping(Generic[KT, VT]):
- def __getitem__(self, key: KT) -> VT:
- ...
- # Etc.
-
- This class can then be used as follows::
-
- def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT:
- try:
- return mapping[key]
- except KeyError:
- return default
-
- .. py:method:: is_convertible(self, value: str) -> bool
-
- Returns `True` if string value provided by `value` is convertible using
- `self.convert(value)`
-
-
- .. py:method:: convert(self, value: str) -> bytes
-
- Implements any conversion logic on `value` to produce `ABIType`.
-
- Must throw if not convertible.
-
-
-
-
-
-.. data:: hex_converter
-
-
-
-
-
-
-.. py:class:: AddressAPIConverter
-
- Bases: :py:obj:`ape.api.ConverterAPI`
-
- Abstract base class for generic types.
-
- A generic type is typically declared by inheriting from
- this class parameterized with one or more type variables.
- For example, a generic mapping type might be defined as::
-
- class Mapping(Generic[KT, VT]):
- def __getitem__(self, key: KT) -> VT:
- ...
- # Etc.
-
- This class can then be used as follows::
-
- def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT:
- try:
- return mapping[key]
- except KeyError:
- return default
-
- .. py:method:: is_convertible(self, value: Any) -> bool
-
- Returns `True` if string value provided by `value` is convertible using
- `self.convert(value)`
-
-
- .. py:method:: convert(self, value: ape.api.AddressAPI) -> ape.types.AddressType
-
- Implements any conversion logic on `value` to produce `ABIType`.
-
- Must throw if not convertible.
-
-
-
-
-
-.. data:: address_api_converter
-
-
-
-
-
-
-.. py:class:: HexAddressConverter
-
- Bases: :py:obj:`ape.api.ConverterAPI`
-
- Abstract base class for generic types.
-
- A generic type is typically declared by inheriting from
- this class parameterized with one or more type variables.
- For example, a generic mapping type might be defined as::
-
- class Mapping(Generic[KT, VT]):
- def __getitem__(self, key: KT) -> VT:
- ...
- # Etc.
-
- This class can then be used as follows::
-
- def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT:
- try:
- return mapping[key]
- except KeyError:
- return default
-
- .. py:method:: is_convertible(self, value: str) -> bool
-
- Returns `True` if string value provided by `value` is convertible using
- `self.convert(value)`
-
-
- .. py:method:: convert(self, value: str) -> ape.types.AddressType
-
- Implements any conversion logic on `value` to produce `ABIType`.
-
- Must throw if not convertible.
-
-
-
-
-
-.. data:: hex_address_converter
-
-
-
-
-
-
-.. py:class:: ConversionManager
-
- .. attribute:: config
- :annotation: :ape.managers.config.ConfigManager
-
-
-
- .. attribute:: plugin_manager
- :annotation: :ape.plugins.PluginManager
-
-
-
- .. attribute:: networks
- :annotation: :ape.managers.networks.NetworkManager
-
-
-
- .. py:method:: _converters(self) -> Dict[Type, List[ape.api.ConverterAPI]]
-
-
- .. py:method:: is_type(self, value: Any, type: Type) -> bool
-
-
- .. py:method:: convert(self, value: Any, type: Type) -> Any
-
-
-
-
diff --git a/latest/_sources/autoapi/ape/managers/index.rst.txt b/latest/_sources/autoapi/ape/managers/index.rst.txt
deleted file mode 100644
index 7114d9d323..0000000000
--- a/latest/_sources/autoapi/ape/managers/index.rst.txt
+++ /dev/null
@@ -1,23 +0,0 @@
-:mod:`ape.managers`
-===================
-
-.. py:module:: ape.managers
-
-
-
-.. raw:: html
-
-
-
-
-**Functions**:
-
-.. autoapisummary::
-
- ape_compile._cli.cli
- ape_compile._cli._display_byte_code_sizes
-
-
-
-
------------
-
-
-.. py:function:: cli(cli_ctx, file_paths, use_cache, display_size)
-
- Compiles the manifest for this project and saves the results
- back to the manifest.
-
- Note that ape automatically recompiles any changed contracts each time
- a project is loaded. You do not have to manually trigger a recompile.
-
-
-
-
-.. py:function:: _display_byte_code_sizes(cli_ctx, contract_types: Dict[str, ape.types.ContractType])
-
-
-
diff --git a/latest/_sources/autoapi/ape_compile/index.rst.txt b/latest/_sources/autoapi/ape_compile/index.rst.txt
deleted file mode 100644
index b3f27164a8..0000000000
--- a/latest/_sources/autoapi/ape_compile/index.rst.txt
+++ /dev/null
@@ -1,94 +0,0 @@
-:mod:`ape_compile`
-==================
-
-.. py:module:: ape_compile
-
-
-
-.. raw:: html
-
-
-
-
-**Functions**:
-
-.. autoapisummary::
-
- ape_run._cli._run_script
- ape_run._cli.cli
-
-
-
-
------------
-
-
-.. py:function:: _run_script(cli_ctx, script_path, interactive=False)
-
-
-
-
-.. py:function:: cli(cli_ctx, scripts, interactive, network)
-
- NAME - Path or script name (from ``scripts/`` folder)
-
- Run scripts from the ``scripts`` folder. A script must either define a ``main()`` method,
- or define an import named ``cli`` that is a ``click.Command`` or ``click.Group`` object.
- ``click.Group`` and ``click.Command`` objects will be provided with additional context, which
- will be injected dynamically during script execution. The dynamically injected objects are
- the exports from the ``ape`` top-level package (similar to how the console works)
-
-
-
diff --git a/latest/_sources/autoapi/ape_run/index.rst.txt b/latest/_sources/autoapi/ape_run/index.rst.txt
deleted file mode 100644
index d3cfc0d5b7..0000000000
--- a/latest/_sources/autoapi/ape_run/index.rst.txt
+++ /dev/null
@@ -1,18 +0,0 @@
-:mod:`ape_run`
-==============
-
-.. py:module:: ape_run
-
-
-
-.. raw:: html
-
-