gridparse 1.5.1__tar.gz → 1.5.3__tar.gz

{gridparse-1.5.1/gridparse.egg-info → gridparse-1.5.3}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: gridparse
-Version: 1.5.1
+Version: 1.5.3
 Summary: Grid search directly from argparse
 Home-page: https://github.com/gchochla/gridparse
 Author: Georgios Chochlakis
@@ -49,10 +49,13 @@ Requires-Dist: black; extra == "dev"
 Requires-Dist: pytest; extra == "dev"
 Dynamic: author
 Dynamic: home-page
+Dynamic: license-file
 
-# GridParse
+![Logo](./media/logo.svg)
 
-A lightweight (only dependency is `omegaconf` which also downloads `yaml`) `ArgumentParser` --- aka `GridArgumentParser` --- that supports your *grid-search* needs. Supports top-level parser and subparsers. Configuration files of any type (using `omegaconf`) as also support through the argument `--gridparse-config` (also available with underscore `_`), where multiple configuration files can be passed and parsed.
+***
+
+`gridparse` is a lightweight (only dependency is `omegaconf` which also downloads `yaml`) `ArgumentParser` - aka `GridArgumentParser` - that supports your *grid-search* needs. Supports top-level parser and subparsers. Configuration files of any type (using `omegaconf`) are also supported through the argument `--gridparse-config` (also available with underscore `_`), where multiple configuration files can be passed and parsed.
 
 ## Overview
 
@@ -70,7 +73,27 @@ So, for single arguments, it extends them similar to nargs="+". For multiple arg
 
 ## Examples
 
-Example without subspaces:
+Example with subspaces:
+
+```python
+parser = GridArgumentParser()
+parser.add_argument("--hparam1", type=int, searchable=True)
+parser.add_argument("--hparam2", type=int, searchable=True)
+parser.add_argument("--hparam3", type=int, searchable=True, default=1000)
+parser.add_argument("--hparam4", type=int, searchable=True, default=2000)
+parser.add_argument("--normal", required=True, type=str)
+
+args = parser.parse_args(
+    (
+        "--hparam1 1 2 "
+        "{--hparam2 1 2 3 {--normal normal --hparam4 100 101 102} {--normal maybe --hparam4 200 201 202 203}} "
+        "{--hparam2 4 5 6 --normal not-normal}"
+    ).split()
+)
+assert len(args) == 2 * ((3 * (3 + 4)) + 3)
+```
+
+Example without subspaces but with lists for grid-search:
 
 ```python
 parser = GridArgumentParser()
@@ -81,23 +104,23 @@ parser.add_argument(
     "--lists",
     required=True,
     nargs="+",
-    type=list_as_dashed_str(str),
+    type=list_as_delim_str(int),
     searchable=True,
 )
 parser.add_argument(
     "--normal_lists",
     required=True,
     nargs="+",
-    type=list_as_dashed_str(str),
+    type=list_as_delim_str(str),
 )
 args = parser.parse_args(
     (
-        "--hparam1 1~~2~~3 --hparam2 4~~3 5~~4 6~~5 "
-        "--normal efrgthytfgn --lists 1-2-3 3-4-5~~6-7 "
-        "--normal_lists 1-2-3 4-5-6"
+        "--hparam1 1 2 3 --hparam2 4|3 5|4 6|5 "
+        "--normal efrgthytfgn --lists 1,-2,3 3,4,5|6,7 "
+        "--normal_lists a,b,c d,e,f"
     ).split()
 )
-assert len(args) == 1 * 3 * 1 * 2 * 1  # corresponding number of different values in input CL arguments
+assert len(args) == 3 * 3 * 1 * 2 * 1  # corresponding number of different values in input CL arguments
 
 pprint(args)
 ```
@@ -122,25 +145,10 @@ Namespace(hparam1=[1, 2, 3], hparam2=[6, 5], lists=[['3', '4', '5'], ['6', '7']]
 ]
 ```
 
-Example with subspaces:
-
-```python
-parser = GridArgumentParser()
-parser.add_argument("--hparam1", type=int, searchable=True)
-parser.add_argument("--hparam2", type=int, searchable=True)
-parser.add_argument("--hparam3", type=int, searchable=True, default=1000)
-parser.add_argument("--hparam4", type=int, searchable=True, default=2000)
-parser.add_argument("--normal", required=True, type=str)
+Searchable argument always use space to designate a different configuration. Namely, notice that for:
+- `nargs` and `searchable=True`, `nargs` is delimited by `|` and `searchable` uses the spaces.
+- `nargs` and `searchable=True` and `list_as_delim_str`, `nargs` uses `|` within each configuration, and `list_as_delim_str` uses `,` within each list of the same configuration, and space is still used by `searchable` to split configurations.
 
-args = parser.parse_args(
-    (
-        "--hparam1 1 2 "
-        "{--hparam2 1 2 3 {--normal normal --hparam4 100 101 102} {--normal maybe --hparam4 200 201 202 203}} "
-        "{--hparam2 4 5 6 --normal not-normal}"
-    ).split()
-)
-assert len(args) == 2 * ((3 * (3 + 4)) + 3)
-```
 
 ## Additional capabilities
 

{gridparse-1.5.1 → gridparse-1.5.3}/README.md

@@ -1,6 +1,8 @@
-# GridParse
+![Logo](./media/logo.svg)
 
-A lightweight (only dependency is `omegaconf` which also downloads `yaml`) `ArgumentParser` --- aka `GridArgumentParser` --- that supports your *grid-search* needs. Supports top-level parser and subparsers. Configuration files of any type (using `omegaconf`) as also support through the argument `--gridparse-config` (also available with underscore `_`), where multiple configuration files can be passed and parsed.
+***
+
+`gridparse` is a lightweight (only dependency is `omegaconf` which also downloads `yaml`) `ArgumentParser` - aka `GridArgumentParser` - that supports your *grid-search* needs. Supports top-level parser and subparsers. Configuration files of any type (using `omegaconf`) are also supported through the argument `--gridparse-config` (also available with underscore `_`), where multiple configuration files can be passed and parsed.
 
 ## Overview
 
@@ -18,7 +20,27 @@ So, for single arguments, it extends them similar to nargs="+". For multiple arg
 
 ## Examples
 
-Example without subspaces:
+Example with subspaces:
+
+```python
+parser = GridArgumentParser()
+parser.add_argument("--hparam1", type=int, searchable=True)
+parser.add_argument("--hparam2", type=int, searchable=True)
+parser.add_argument("--hparam3", type=int, searchable=True, default=1000)
+parser.add_argument("--hparam4", type=int, searchable=True, default=2000)
+parser.add_argument("--normal", required=True, type=str)
+
+args = parser.parse_args(
+    (
+        "--hparam1 1 2 "
+        "{--hparam2 1 2 3 {--normal normal --hparam4 100 101 102} {--normal maybe --hparam4 200 201 202 203}} "
+        "{--hparam2 4 5 6 --normal not-normal}"
+    ).split()
+)
+assert len(args) == 2 * ((3 * (3 + 4)) + 3)
+```
+
+Example without subspaces but with lists for grid-search:
 
 ```python
 parser = GridArgumentParser()
@@ -29,23 +51,23 @@ parser.add_argument(
     "--lists",
     required=True,
     nargs="+",
-    type=list_as_dashed_str(str),
+    type=list_as_delim_str(int),
     searchable=True,
 )
 parser.add_argument(
     "--normal_lists",
     required=True,
     nargs="+",
-    type=list_as_dashed_str(str),
+    type=list_as_delim_str(str),
 )
 args = parser.parse_args(
     (
-        "--hparam1 1~~2~~3 --hparam2 4~~3 5~~4 6~~5 "
-        "--normal efrgthytfgn --lists 1-2-3 3-4-5~~6-7 "
-        "--normal_lists 1-2-3 4-5-6"
+        "--hparam1 1 2 3 --hparam2 4|3 5|4 6|5 "
+        "--normal efrgthytfgn --lists 1,-2,3 3,4,5|6,7 "
+        "--normal_lists a,b,c d,e,f"
     ).split()
 )
-assert len(args) == 1 * 3 * 1 * 2 * 1  # corresponding number of different values in input CL arguments
+assert len(args) == 3 * 3 * 1 * 2 * 1  # corresponding number of different values in input CL arguments
 
 pprint(args)
 ```
@@ -70,25 +92,10 @@ Namespace(hparam1=[1, 2, 3], hparam2=[6, 5], lists=[['3', '4', '5'], ['6', '7']]
 ]
 ```
 
-Example with subspaces:
-
-```python
-parser = GridArgumentParser()
-parser.add_argument("--hparam1", type=int, searchable=True)
-parser.add_argument("--hparam2", type=int, searchable=True)
-parser.add_argument("--hparam3", type=int, searchable=True, default=1000)
-parser.add_argument("--hparam4", type=int, searchable=True, default=2000)
-parser.add_argument("--normal", required=True, type=str)
+Searchable argument always use space to designate a different configuration. Namely, notice that for:
+- `nargs` and `searchable=True`, `nargs` is delimited by `|` and `searchable` uses the spaces.
+- `nargs` and `searchable=True` and `list_as_delim_str`, `nargs` uses `|` within each configuration, and `list_as_delim_str` uses `,` within each list of the same configuration, and space is still used by `searchable` to split configurations.
 
-args = parser.parse_args(
-    (
-        "--hparam1 1 2 "
-        "{--hparam2 1 2 3 {--normal normal --hparam4 100 101 102} {--normal maybe --hparam4 200 201 202 203}} "
-        "{--hparam2 4 5 6 --normal not-normal}"
-    ).split()
-)
-assert len(args) == 2 * ((3 * (3 + 4)) + 3)
-```
 
 ## Additional capabilities
 

{gridparse-1.5.1 → gridparse-1.5.3}/gridparse/__init__.py

@@ -1,4 +1,4 @@
 from argparse import *
 
 from .grid_argument_parser import GridArgumentParser
-from .utils import list_as_dashed_str, strbool
+from .utils import list_as_delim_str, strbool

{gridparse-1.5.1 → gridparse-1.5.3}/gridparse/grid_argument_parser.py

@@ -5,7 +5,7 @@ from typing import Any, Tuple, List, Optional, Union, Sequence
 from copy import deepcopy
 from omegaconf import OmegaConf
 
-from gridparse.utils import list_as_dashed_str, strbool
+from gridparse.utils import list_as_delim_str, strbool
 
 
 class AuxArgumentParser(argparse.ArgumentParser):
@@ -14,7 +14,7 @@ class AuxArgumentParser(argparse.ArgumentParser):
 
     def parse_known_args(
         self, args=None, namespace=None
-    ) -> Tuple[argparse.Namespace, List[str], Set[str]]:
+    ) -> Tuple[argparse.Namespace, List[str]]:
         """Overwritten to collect the argument names that
         are specified in the command line."""
         if args is None:
@@ -61,7 +61,7 @@ class AuxArgumentParser(argparse.ArgumentParser):
 
     def _parse_known_args(
         self, arg_strings, namespace
-    ) -> Tuple[List[argparse.Namespace], List[str], Set[str]]:
+    ) -> Tuple[List[argparse.Namespace], List[str]]:
         """Overwritten to collect the argument names that
         are specified in the command line."""
 
@@ -710,7 +710,7 @@ class GridArgumentParser(_GridActionsContainer, AuxArgumentParser):
             type = kwargs.get("type", None)
 
             if nargs == "+":
-                type = list_as_dashed_str(type, delimiter="~~")
+                type = list_as_delim_str(type, delimiter="|")
             else:
                 nargs = "+"
 

{gridparse-1.5.1 → gridparse-1.5.3}/gridparse/utils.py

@@ -2,12 +2,12 @@ import argparse
 from typing import Callable
 
 
-# TODO: has issues with negative numbers
-def list_as_dashed_str(actual_type: Callable, delimiter: str = "-"):
+# NOTE: has issues with negative numbers if delim="-"
+def list_as_delim_str(actual_type: Callable, delimiter: str = ","):
     """Creates a function that converts a string to a list of elements.
 
     Can be used as the `type` argument in `argparse` to convert
-    a string to a list of elements, e.g.: `["1-2-3", "4-5-6"]` to
+    a string to a list of elements, e.g.: `["1,2,3", "4,5,6"]` to
     `[[1, 2, 3], [4, 5, 6]]` (note that this operates on a single
     `str` at a time, use `nargs` to pass multiple).
 

{gridparse-1.5.1 → gridparse-1.5.3/gridparse.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: gridparse
-Version: 1.5.1
+Version: 1.5.3
 Summary: Grid search directly from argparse
 Home-page: https://github.com/gchochla/gridparse
 Author: Georgios Chochlakis
@@ -49,10 +49,13 @@ Requires-Dist: black; extra == "dev"
 Requires-Dist: pytest; extra == "dev"
 Dynamic: author
 Dynamic: home-page
+Dynamic: license-file
 
-# GridParse
+![Logo](./media/logo.svg)
 
-A lightweight (only dependency is `omegaconf` which also downloads `yaml`) `ArgumentParser` --- aka `GridArgumentParser` --- that supports your *grid-search* needs. Supports top-level parser and subparsers. Configuration files of any type (using `omegaconf`) as also support through the argument `--gridparse-config` (also available with underscore `_`), where multiple configuration files can be passed and parsed.
+***
+
+`gridparse` is a lightweight (only dependency is `omegaconf` which also downloads `yaml`) `ArgumentParser` - aka `GridArgumentParser` - that supports your *grid-search* needs. Supports top-level parser and subparsers. Configuration files of any type (using `omegaconf`) are also supported through the argument `--gridparse-config` (also available with underscore `_`), where multiple configuration files can be passed and parsed.
 
 ## Overview
 
@@ -70,7 +73,27 @@ So, for single arguments, it extends them similar to nargs="+". For multiple arg
 
 ## Examples
 
-Example without subspaces:
+Example with subspaces:
+
+```python
+parser = GridArgumentParser()
+parser.add_argument("--hparam1", type=int, searchable=True)
+parser.add_argument("--hparam2", type=int, searchable=True)
+parser.add_argument("--hparam3", type=int, searchable=True, default=1000)
+parser.add_argument("--hparam4", type=int, searchable=True, default=2000)
+parser.add_argument("--normal", required=True, type=str)
+
+args = parser.parse_args(
+    (
+        "--hparam1 1 2 "
+        "{--hparam2 1 2 3 {--normal normal --hparam4 100 101 102} {--normal maybe --hparam4 200 201 202 203}} "
+        "{--hparam2 4 5 6 --normal not-normal}"
+    ).split()
+)
+assert len(args) == 2 * ((3 * (3 + 4)) + 3)
+```
+
+Example without subspaces but with lists for grid-search:
 
 ```python
 parser = GridArgumentParser()
@@ -81,23 +104,23 @@ parser.add_argument(
     "--lists",
     required=True,
     nargs="+",
-    type=list_as_dashed_str(str),
+    type=list_as_delim_str(int),
     searchable=True,
 )
 parser.add_argument(
     "--normal_lists",
     required=True,
     nargs="+",
-    type=list_as_dashed_str(str),
+    type=list_as_delim_str(str),
 )
 args = parser.parse_args(
     (
-        "--hparam1 1~~2~~3 --hparam2 4~~3 5~~4 6~~5 "
-        "--normal efrgthytfgn --lists 1-2-3 3-4-5~~6-7 "
-        "--normal_lists 1-2-3 4-5-6"
+        "--hparam1 1 2 3 --hparam2 4|3 5|4 6|5 "
+        "--normal efrgthytfgn --lists 1,-2,3 3,4,5|6,7 "
+        "--normal_lists a,b,c d,e,f"
     ).split()
 )
-assert len(args) == 1 * 3 * 1 * 2 * 1  # corresponding number of different values in input CL arguments
+assert len(args) == 3 * 3 * 1 * 2 * 1  # corresponding number of different values in input CL arguments
 
 pprint(args)
 ```
@@ -122,25 +145,10 @@ Namespace(hparam1=[1, 2, 3], hparam2=[6, 5], lists=[['3', '4', '5'], ['6', '7']]
 ]
 ```
 
-Example with subspaces:
-
-```python
-parser = GridArgumentParser()
-parser.add_argument("--hparam1", type=int, searchable=True)
-parser.add_argument("--hparam2", type=int, searchable=True)
-parser.add_argument("--hparam3", type=int, searchable=True, default=1000)
-parser.add_argument("--hparam4", type=int, searchable=True, default=2000)
-parser.add_argument("--normal", required=True, type=str)
+Searchable argument always use space to designate a different configuration. Namely, notice that for:
+- `nargs` and `searchable=True`, `nargs` is delimited by `|` and `searchable` uses the spaces.
+- `nargs` and `searchable=True` and `list_as_delim_str`, `nargs` uses `|` within each configuration, and `list_as_delim_str` uses `,` within each list of the same configuration, and space is still used by `searchable` to split configurations.
 
-args = parser.parse_args(
-    (
-        "--hparam1 1 2 "
-        "{--hparam2 1 2 3 {--normal normal --hparam4 100 101 102} {--normal maybe --hparam4 200 201 202 203}} "
-        "{--hparam2 4 5 6 --normal not-normal}"
-    ).split()
-)
-assert len(args) == 2 * ((3 * (3 + 4)) + 3)
-```
 
 ## Additional capabilities
 

{gridparse-1.5.1 → gridparse-1.5.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "gridparse"
-version = "1.5.1"
+version = "1.5.3"
 description = "Grid search directly from argparse"
 readme = "README.md"
 requires-python = ">=3.7"

{gridparse-1.5.1 → gridparse-1.5.3}/setup.py

@@ -5,7 +5,7 @@ with open("README.md", "r", encoding="utf-8") as fh:
 
 setup(
     name="gridparse",
-    version="1.5.1",
+    version="1.5.3",
     description="Grid search directly from argparse",
     author="Georgios Chochlakis",
     author_email="georgioschochlakis@gmail.com",