WIP: Documentation improvement and format change to Google
Some checks failed
Analysis / SonarCloud (push) Successful in 54s
Analysis / SonarCloud (pull_request) Successful in 48s
Tests / Build and Test (3.11) (pull_request) Failing after 1m2s
Tests / Build and Test (3.12) (pull_request) Failing after 1m0s
Tests / Build and Test (3.13) (pull_request) Failing after 59s
Some checks failed
Analysis / SonarCloud (push) Successful in 54s
Analysis / SonarCloud (pull_request) Successful in 48s
Tests / Build and Test (3.11) (pull_request) Failing after 1m2s
Tests / Build and Test (3.12) (pull_request) Failing after 1m0s
Tests / Build and Test (3.13) (pull_request) Failing after 59s
This commit is contained in:
@@ -4,14 +4,14 @@ from typing import Callable
|
||||
|
||||
|
||||
def supports_argument(func: Callable[..., Any], arg_name: str) -> bool:
|
||||
"""Check whether a function has a specific argument
|
||||
"""Check whether a function has a specific argument.
|
||||
|
||||
### Args:
|
||||
* func (`Callable[..., Any]`): Function to be inspected
|
||||
* arg_name (`str`): Argument to be checked
|
||||
Args:
|
||||
func (Callable[..., Any]): Function to be inspected.
|
||||
arg_name (str): Argument to be checked.
|
||||
|
||||
### Returns:
|
||||
* `bool`: `True` if argument is supported and `False` if not
|
||||
Returns:
|
||||
bool: True if argument is supported and False if not.
|
||||
"""
|
||||
if hasattr(func, "__code__"):
|
||||
return arg_name in inspect.signature(func).parameters
|
||||
@@ -29,17 +29,17 @@ def nested_set(
|
||||
) -> Dict[str, Any]:
|
||||
"""Set the key by its path to the value
|
||||
|
||||
### Args:
|
||||
* target (`Dict[str, Any]`): Dictionary to perform modifications on
|
||||
* value (`Any`): Any data
|
||||
* *path (`str`): Path to the key of the target
|
||||
* create_missing (`bool`, *optional*): Create keys on the way if they're missing. Defaults to `True`
|
||||
Args:
|
||||
target (Dict[str, Any]): Dictionary to perform the modification on.
|
||||
value (Any): New value.
|
||||
*path (str): Path to the key.
|
||||
create_missing (:obj:`bool`, optional): Create keys on the way if they're missing. Defaults to True.
|
||||
|
||||
### Raises:
|
||||
* `KeyError`: Key is not found under path provided
|
||||
Raises:
|
||||
KeyError: Key is not found under the provided path.
|
||||
|
||||
### Returns:
|
||||
* `Dict[str, Any]`: Changed dictionary
|
||||
Returns:
|
||||
Dict[str, Any]: Modified dictionary.
|
||||
"""
|
||||
target_copy: Dict[str, Any] = target
|
||||
|
||||
@@ -60,16 +60,16 @@ def nested_set(
|
||||
|
||||
|
||||
def nested_delete(target: Dict[str, Any], *path: str) -> Dict[str, Any]:
|
||||
"""Delete the key by its path
|
||||
"""Delete the key by its path.
|
||||
|
||||
### Args:
|
||||
* target (`Dict[str, Any]`): Dictionary to perform modifications on
|
||||
Args:
|
||||
target (Dict[str, Any]): Dictionary to perform the modification on.
|
||||
|
||||
### Raises:
|
||||
* `KeyError`: Key is not found under path provided
|
||||
Raises:
|
||||
KeyError: Key is not found under the provided path.
|
||||
|
||||
### Returns:
|
||||
`Dict[str, Any]`: Changed dictionary
|
||||
Returns:
|
||||
Dict[str, Any]: Modified dictionary.
|
||||
"""
|
||||
target_copy: Dict[str, Any] = target
|
||||
|
||||
|
Reference in New Issue
Block a user