Skip to content

Commit

Permalink
version 3.4.6
Browse files Browse the repository at this point in the history 
- add longer versions of some flags, update docs
  • Loading branch information
@elesiuta
elesiuta committed Oct 11, 2024
1 parent f555d1d commit 7e33f40
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 34 deletions.
41 changes: 23 additions & 18 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,21 +15,24 @@ Build and execute command lines, python code, or mix from standard input or
file paths. The file input mode (default if stdin is not connected) builds
commands using filenames only and executes them in their respective
directories, this is useful when dealing with file paths containing multiple
character encodings.
character encodings. When executing python code, the following variables are
provided: i=index, j=remaining, n=total, x=input, s=split, d=dir,
a=all_inputs, out=previous_results, df=dataframe, js=json, db=duckdb
options:
-h, --help show this help message and exit
--version show program's version number and exit
-m input-mode options are:
file = build commands from filenames and execute in
each subdirectory respectively
path = build commands from file paths relative to
the current directory and execute in the
current directory
abspath = build commands from absolute file paths and
execute in the current directory
stdin = build commands from standard input and
execute in the current directory
-m input-mode, --mode input-mode
options are:
(f)ile = build commands from filenames and execute
in each subdirectory respectively
(p)ath = build commands from file paths relative
to the current directory and execute in
the current directory
(a)bspath = build commands from absolute file paths
and execute in the current directory
(s)tdin = build commands from standard input and
execute in the current directory
default: stdin if connected, otherwise file
--folders use folders instead files (for input modes: file,
path, abspath)
Expand Down Expand Up @@ -70,11 +73,12 @@ options:
--resub pattern substitution replace-str
replace occurrences of replace-str in command with
re.sub(patten, substitution, input)
-r regex only build commands from inputs matching regex for
-r regex, --filter regex
only build commands from inputs matching regex for
input mode stdin, and matching relative paths for all
other input modes, uses re.search
-o omit inputs matching regex instead
-b only match regex against basename of input (for input
-o, --omit omit inputs matching regex instead
-b, --basename only match regex against basename of input (for input
modes: file, path, abspath)
-f, --fstring evaluates commands as python f-strings before
execution
Expand Down Expand Up @@ -137,10 +141,11 @@ options:
# you can also evaluate and print python f-strings, the index i is provided
> pyxr --pypr "number: {i}\tname: {}"

# provided variables: i=index, j=remaining, n=total, x=input, d=dir
# a is a list of all previous inputs, so a[i]=x
# out is a list of all previous outputs, so out[i]=output (for -e, -p, -q)
# s is like a list of columns if each x is a row, by default s=x.split()
# provided variables:
# i = index, j = remaining, n = total, x = input, d = dir
# a = a list of all inputs, so a[i]=x
# out = a list of previous outputs, so out[i]=output (for -e, -p, -q)
# s = a list of columns if each x is a row, by default s=x.split()
# if the input mode is path or abspath, s=x.split(os.path.sep)
# if the input mode is file, s=os.path.splitext(x)
# if -s or -g is specified, then it is re.split() or re.search().groups()
Expand Down
33 changes: 17 additions & 16 deletions pyxargs.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
import typing


__version__: typing.Final[str] = "3.4.5"
__version__: typing.Final[str] = "3.4.6"


def replace_surrogates(string: str) -> str:
Expand Down Expand Up @@ -333,8 +333,9 @@ def _split_lines(self, text, width):
return argparse.HelpFormatter._split_lines(self, text, width)
readme = ("Build and execute command lines, python code, or mix from standard input or file paths. "
"The file input mode (default if stdin is not connected) builds commands using filenames only and executes them in their respective directories, "
"this is useful when dealing with file paths containing multiple character encodings.")
parser = argparse.ArgumentParser(description=readme, epilog="Source code: https://github.com/elesiuta/pyxargs",
"this is useful when dealing with file paths containing multiple character encodings. "
"When executing python code, the following variables are provided: i=index, j=remaining, n=total, x=input, s=split, d=dir, a=all_inputs, out=previous_results, df=dataframe, js=json, db=duckdb")
parser = argparse.ArgumentParser(description=readme, epilog="Source: https://github.com/elesiuta/pyxargs",
formatter_class=lambda prog: ArgparseCustomFormatter(prog, max_help_position=24),
usage="%(prog)s [options] command [initial-arguments ...]\n"
" %(prog)s -h | --help | --version")
Expand All @@ -346,18 +347,18 @@ def _split_lines(self, text, width):
parser.add_argument("--version", action="version", version=__version__)
parser.add_argument("--base-directory", type=str, default=os.getcwd(), metavar="base-directory", dest="base_dir",
help=argparse.SUPPRESS)
parser.add_argument("-m", type=str, default=None, metavar="input-mode", choices=['file', 'path', 'abspath', 'stdin', "f", "p", "a", "s"], dest="input_mode",
parser.add_argument("-m", "--mode", type=str, default=None, metavar="input-mode", choices=['file', 'path', 'abspath', 'stdin', "f", "p", "a", "s"], dest="input_mode",
help="F!\n"
"options are:\n"
"file = build commands from filenames and execute in\n"
" each subdirectory respectively\n"
"path = build commands from file paths relative to\n"
" the current directory and execute in the\n"
" current directory\n"
"abspath = build commands from absolute file paths and \n"
" execute in the current directory\n"
"stdin = build commands from standard input and\n"
" execute in the current directory\n"
"(f)ile = build commands from filenames and execute\n"
" in each subdirectory respectively\n"
"(p)ath = build commands from file paths relative\n"
" to the current directory and execute in\n"
" the current directory\n"
"(a)bspath = build commands from absolute file paths\n"
" and execute in the current directory\n"
"(s)tdin = build commands from standard input and\n"
" execute in the current directory\n"
"default: stdin if connected, otherwise file")
group2.add_argument("--folders", action="store_true", dest="folders",
help="use folders instead files (for input modes: file, path, abspath)")
Expand All @@ -383,11 +384,11 @@ def _split_lines(self, text, width):
help="replace occurrences of replace-str in command with input, default: {}")
parser.add_argument("--resub", nargs=3, type=str, metavar=("pattern", "substitution", "replace-str"), dest="resub",
help="replace occurrences of replace-str in command with re.sub(patten, substitution, input)")
parser.add_argument("-r", type=str, default=None, metavar="regex", dest="regex_filter",
parser.add_argument("-r", "--filter", type=str, default=None, metavar="regex", dest="regex_filter",
help="only build commands from inputs matching regex for input mode stdin, and matching relative paths for all other input modes, uses re.search")
parser.add_argument("-o", action="store_true", dest="regex_omit",
parser.add_argument("-o", "--omit", action="store_true", dest="regex_omit",
help="omit inputs matching regex instead")
parser.add_argument("-b", action="store_true", dest="regex_basename",
parser.add_argument("-b", "--basename", action="store_true", dest="regex_basename",
help="only match regex against basename of input (for input modes: file, path, abspath)")
parser.add_argument("-f", "--fstring", action="store_true", dest="fstring",
help="evaluates commands as python f-strings before execution")
Expand Down

0 comments on commit 7e33f40

Please sign in to comment.