dstamp 3__tar.gz → 4__tar.gz

{dstamp-3 → dstamp-4}/PKG-INFO

@@ -1,16 +1,17 @@
 Metadata-Version: 2.4
 Name: dstamp
-Version: 3
+Version: 4
 Summary: CLI app for generating timestamps for use in Discord chats.
 Keywords: discord,generator,timestamp
 Author: Mariusz Tang
 Author-email: Mariusz Tang <dev@mariusztang.com>
 License-Expression: MIT
-Classifier: Development Status :: 4 - Beta
+Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console
 Classifier: Intended Audience :: End Users/Desktop
 Classifier: Topic :: Communications :: Chat
 Requires-Dist: argcomplete>=3.6.3
+Requires-Dist: logassert>=8.6
 Requires-Dist: platformdirs>=4.10.0
 Requires-Dist: pyperclip>=1.11.0
 Requires-Python: >=3.14
@@ -49,21 +50,30 @@ dstamp get
 # Get the current time, to the nearest 15 minutes.
 dstamp get --precision 15m
 
-# Show the config file location.
+# Get the time 20 minutes from now.
+dstamp in 20m
+
+# Show the default config file location.
 dstamp show-config
 ```
 
 See the help messages for full usage information:
 
 ```bash
-dstamp -h
+dstamp --help
 dstamp -h get
+dstamp -h in
 ```
 
 ### Configuration
 
 Dstamp supports configuration by TOML file. See `dstamp -h show-config` for full
-information.
+information. The config file location can be overridden using the `--config`
+option.
+
+## Logs
+
+Dstamp writes logs to a file. Use `dstamp show-log` to get the file location.
 
 ## Shell completion
 

{dstamp-3 → dstamp-4}/README.md

@@ -29,21 +29,30 @@ dstamp get
 # Get the current time, to the nearest 15 minutes.
 dstamp get --precision 15m
 
-# Show the config file location.
+# Get the time 20 minutes from now.
+dstamp in 20m
+
+# Show the default config file location.
 dstamp show-config
 ```
 
 See the help messages for full usage information:
 
 ```bash
-dstamp -h
+dstamp --help
 dstamp -h get
+dstamp -h in
 ```
 
 ### Configuration
 
 Dstamp supports configuration by TOML file. See `dstamp -h show-config` for full
-information.
+information. The config file location can be overridden using the `--config`
+option.
+
+## Logs
+
+Dstamp writes logs to a file. Use `dstamp show-log` to get the file location.
 
 ## Shell completion
 

{dstamp-3 → dstamp-4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "dstamp"
-version = "3"
+version = "4"
 description = "CLI app for generating timestamps for use in Discord chats."
 readme = "README.md"
 requires-python = ">=3.14"
@@ -8,13 +8,14 @@ license = "MIT"
 authors = [{ name = "Mariusz Tang", email = "dev@mariusztang.com" }]
 keywords = ["discord", "generator", "timestamp"]
 classifiers = [
-  "Development Status :: 4 - Beta",
+  "Development Status :: 5 - Production/Stable",
   "Environment :: Console",
   "Intended Audience :: End Users/Desktop",
   "Topic :: Communications :: Chat",
 ]
 dependencies = [
   "argcomplete>=3.6.3",
+  "logassert>=8.6",
   "platformdirs>=4.10.0",
   "pyperclip>=1.11.0",
 ]
@@ -81,3 +82,4 @@ select = [
 ]
 pydocstyle.convention = "pep257"
 per-file-ignores = { "tests/**/*" = ["D"] }
+flake8-annotations.allow-star-arg-any = true

{dstamp-3 → dstamp-4}/src/dstamp/__init__.py

@@ -1 +1,3 @@
 """CLI tool for printing Discord timestamps."""
+
+APP_NAME = "dstamp"

dstamp-4/src/dstamp/cli.py

@@ -0,0 +1,172 @@
+# PYTHON_ARGCOMPLETE_OK
+"""Dstamp's CLI interface."""
+
+import argparse
+import logging
+import logging.config
+import pathlib
+import sys
+import tomllib
+from collections.abc import Iterable
+
+import argcomplete
+import pyperclip
+
+import dstamp.logging
+from dstamp import config, exceptions, subcommands
+
+logger = logging.getLogger(__name__)
+
+# Use a base parser to change the help flag's help message.
+base_parser = argparse.ArgumentParser(add_help=False)
+base_parser.add_argument(
+    "-h",
+    "--help",
+    action="help",
+    help="Show this help message and exit.",
+)
+
+
+def construct_parser(config: dict | None = None) -> argparse.ArgumentParser:
+    """Create the dstamp CLI argument parser."""
+    # Add the help option manually so we can change the help message.
+    parser = argparse.ArgumentParser(
+        add_help=False,
+        parents=[base_parser],
+        description="Discord timestamp generator.",
+        epilog="Some options can be set via config file. See %(prog)s -h show-config",
+        suggest_on_error=True,
+    )
+    parser.add_argument(
+        "--version",
+        action="version",
+        version="%(prog)s 4",
+        help="Show version number and exit.",
+    )
+    parser.add_argument(
+        "--config",
+        metavar="CONFIG_PATH",
+        type=pathlib.Path,
+        help="Alternative config file to use instead of the default. Should be "
+        "a TOML file.",
+    )
+    parser.add_argument(
+        "--quiet",
+        action=argparse.BooleanOptionalAction,
+        help="Do not print warnings to the console. Disabled by default.",
+    )
+    parser.add_argument(
+        "--verbose",
+        action=argparse.BooleanOptionalAction,
+        help="Print detailed info messages to the console. Takes precedence over "
+        "--quiet. Disabled by default.",
+    )
+
+    subparsers = parser.add_subparsers(title="commands")
+    subcommands.register_all(subparsers, config or {})
+
+    return parser
+
+
+def run(args: Iterable[str] | None = None) -> None:
+    """Parse `args` as CLI arguments and execute the resulting command."""
+    parser = construct_parser()
+    argcomplete.autocomplete(parser)
+
+    # Move help flags past subcommands so the most specific help message is shown.
+    args = _move_help_to_end(args or sys.argv[1:])
+    parsed_args = parser.parse_args(args)
+
+    # Print help if no arguments are provided.
+    if not hasattr(parsed_args, "func"):
+        parser.print_help()
+        return
+
+    # Read the config file.
+    config_path, config_, unknown_keys, config_warning = _get_config(parsed_args.config)
+
+    # Re-parse the arguments with defaults from the config.
+    # We use this method because the config path needs to be known at parse
+    # time, but we cannot determine an overridden config path before parsing.
+    parser = construct_parser(config_)
+    parsed_args = parser.parse_args(args)
+
+    # Configure logging only after reading the config.
+    verbosity = (
+        "verbose" if parsed_args.verbose else "quiet" if parsed_args.quiet else "normal"
+    )
+    logging.config.dictConfig(dstamp.logging.get_config(verbosity))
+
+    # Now we can start logging.
+    logger.info(f"args: {args or sys.argv[1:]}")
+
+    logger.info(f"using config in {config_path}")
+    if config_warning:
+        logger.warning(config_warning)
+
+    logger.info(f"computed config options: {config_}")
+    if unknown_keys:
+        logger.warning(f"unknown keys in config file: {', '.join(unknown_keys)}")
+
+    try:
+        parsed_args.func(parsed_args)
+    except exceptions.DstampError as e:
+        parser.error(str(e))
+    except pyperclip.PyperclipException as e:
+        parser.error(f"there was a problem with the clipboard manager: {e}")
+    except Exception:
+        logger.exception("An unexpected error occurred.")
+        parser.error("an unexpected error occurred; please report this to dstamp")
+
+
+def _move_help_to_end(args: Iterable[str]) -> Iterable[str]:
+    args = list(args)
+    if "-h" not in args and "--help" not in args:
+        return args
+
+    # Remove --version so it doesn't override the help flag if present.
+    _remove_arg(args, "--version")
+    _remove_arg(args, "--help")
+    _remove_arg(args, "-h")
+
+    args.append("--help")
+    return args
+
+
+def _remove_arg(args: list[str], arg: str) -> None:
+    while arg in args:
+        args.remove(arg)
+
+
+def _get_config(
+    config_path_arg: pathlib.Path | None,
+) -> tuple[pathlib.Path, dict, set, str | None]:
+    """Get config from `config_path_arg`.
+
+    Returns the effective config path, cleaned config, unknown keys set, and
+    a warning message if applicable.
+    """
+    log_warning = None
+
+    # Log if config path is specified at the command line but cannot be used.
+    if config_path_arg:
+        if not config_path_arg.exists():
+            log_warning = "specified config file does not exist"
+        elif not config_path_arg.is_file():
+            log_warning = "specified config path is not a file"
+
+    # Default result if we cannot read a file.
+    config_cleaned = {}
+    unknown_keys = set()
+
+    config_path = config_path_arg or config.default_path()
+    if config_path.is_file():
+        try:
+            config_raw = tomllib.loads(config_path.read_text())
+        except tomllib.TOMLDecodeError:
+            log_warning = "config file is not valid TOML"
+        else:
+            # Override result with file contents.
+            config_cleaned, unknown_keys = config.clean(config_raw)
+
+    return config_path, config_cleaned, unknown_keys, log_warning

dstamp-4/src/dstamp/config.py

@@ -0,0 +1,40 @@
+"""Config file utilities.
+
+The functions in this module do not create a config file if one does not exist.
+"""
+
+import pathlib
+from typing import Any
+
+import platformdirs
+
+import dstamp
+
+
+def default_path() -> pathlib.Path:
+    """Return the default config file path.
+
+    Note that the file does not necessarily exist.
+    """
+    config_dir = platformdirs.user_config_path(dstamp.APP_NAME)
+    return config_dir / "config.toml"
+
+
+_VALID_KEYS = {
+    "copy",
+    "format",
+    "precision",
+    "quiet",
+    "verbose",
+}
+
+
+def clean(config: dict) -> tuple[dict[str, Any], set[str]]:
+    """Clean a config dict so it contains only valid keys.
+
+    Returns a dictionary containing the cleaned config and a set containing the
+    invalid keys that were found in the input.
+    """
+    cleaned_config = {key: value for key, value in config.items() if key in _VALID_KEYS}
+    unknown_keys = config.keys() - _VALID_KEYS
+    return cleaned_config, unknown_keys

dstamp-4/src/dstamp/logging.py

@@ -0,0 +1,52 @@
+"""Defines dstamp's logging configuration."""
+
+import platformdirs
+
+import dstamp
+
+LOG_DIR = platformdirs.user_log_path(dstamp.APP_NAME, ensure_exists=True)
+
+CONFIG = {
+    "version": 1,
+    "formatters": {
+        "short": {"format": "%(levelname)s: %(message)s"},
+        "full": {"format": "%(asctime)s %(levelname)s: %(name)s: %(message)s"},
+    },
+    "handlers": {
+        "console": {
+            "class": "logging.StreamHandler",
+            "formatter": "short",
+            "level": "WARNING",
+        },
+        "file": {
+            "class": "logging.handlers.RotatingFileHandler",
+            "formatter": "full",
+            "filename": LOG_DIR / f"{dstamp.APP_NAME}.log",
+            "encoding": "utf-8",
+            "maxBytes": 50_000,
+            "backupCount": 1,
+        },
+    },
+    "root": {
+        "level": "INFO",
+        "handlers": ["console", "file"],
+    },
+    "disable_existing_loggers": False,
+}
+
+
+def get_config(verbosity: str) -> dict:
+    """Get an appropriate logging configuration for the given `verbosity`.
+
+    :param verbosity: recognized values are "quiet" and "verbose". Other values
+    are ignored and produce the default config.
+    """
+    # Use unspecific type annotation to avoid type errors below.
+    base: dict = CONFIG
+
+    if verbosity == "quiet":
+        base["root"]["handlers"].remove("console")
+    elif verbosity == "verbose":
+        base["handlers"]["console"]["level"] = "INFO"
+
+    return base

{dstamp-3 → dstamp-4}/src/dstamp/parse.py

@@ -6,7 +6,7 @@ from collections import Counter
 
 from dstamp import exceptions, round
 
-MONTHS = [
+_MONTHS = [
     "jan",
     "feb",
     "mar",
@@ -31,12 +31,12 @@ def date(input: str) -> dt.date:
     if input == "yesterday":
         return dt.date.today() - dt.timedelta(1)
 
-    m = re.fullmatch(rf"(\d+)({'|'.join(MONTHS)})(\d+)?", input.lower())
+    m = re.fullmatch(rf"(\d+)({'|'.join(_MONTHS)})(\d+)?", input.lower())
     if not m:
         raise exceptions.ParserFormatError(input, dt.date)
 
     day = int(m[1])
-    month = MONTHS.index(m[2]) + 1
+    month = _MONTHS.index(m[2]) + 1
     year = int(m[3]) if m[3] else dt.date.today().year
 
     try:

dstamp-4/src/dstamp/subcommands/__init__.py

@@ -0,0 +1,15 @@
+"""Dstamp subcommands."""
+
+import argparse
+
+from . import get, show_config, show_log
+
+
+def register_all(subparsers: argparse._SubParsersAction, config: dict) -> None:
+    """Register all subcommands as subparsers."""
+    get.register(subparsers, config)
+    show_config.register(subparsers)
+    show_log.register(subparsers)
+
+
+__all__ = ["register_all"]

dstamp-4/src/dstamp/subcommands/get.py

@@ -0,0 +1,182 @@
+"""The get timestamp command, and the related in command."""
+
+import argparse
+import datetime as dt
+import logging
+from typing import Any
+
+import pyperclip
+
+import dstamp
+from dstamp import cli, discord, exceptions, parse, round
+
+logger = logging.getLogger(__name__)
+
+
+def register(subparsers: argparse._SubParsersAction, config: dict) -> None:
+    """Register the get and in commands as subparsers."""
+    base = argparse.ArgumentParser(add_help=False)
+    base.add_argument(
+        "-c",
+        "--copy",
+        action=argparse.BooleanOptionalAction,
+        default=True,
+        help="If set, copy the result to clipboard. Enabled by default.",
+    )
+    base.add_argument(
+        "-p",
+        "--precision",
+        default="1s",
+        help="The precision to which the date and time should be rounded. "
+        "Examples: 1s, 30m, 2h, 24h, 60s, 60m. The only valid units are h "
+        "(hours), m (minutes), and s (seconds). The quantity must be a factor "
+        "of 60 (minutes or seconds) or 24 (hours). The default is 1s.",
+    )
+
+    get: argparse.ArgumentParser = subparsers.add_parser(
+        "get",
+        help="Generate a timestamp.",
+        description="Generate a Discord-compatible timestamp.",
+        epilog=f"Some options can be set via config file. See {dstamp.APP_NAME} "
+        "-h show-config",
+        add_help=False,
+        parents=[cli.base_parser, base],
+    )
+    get.add_argument(
+        "date",
+        nargs="?",
+        help="Examples: 1jan2025, 30may2020, 6jun. If the year is omitted, the "
+        "current year is used. If the entire date is omitted, the current date "
+        "is used. Accepts special keywords: today, tomorrow, tmrw, yesterday.",
+    )
+    get.add_argument(
+        "time",
+        nargs="?",
+        help="Examples: 1, 15, 1730, 35004pm. If omitted, midnight is used. If "
+        "the date is also omitted, the current time is used instead. Can be "
+        "provided even if the date is omitted. Accepts special keywords: now "
+        "(current time), midnight, noon.",
+    )
+    get.add_argument(
+        "-o",
+        "--offset",
+        help="An offset to apply to the date and time. Examples: 1d (one day), "
+        "3h5m (three hours and five minutes), 5s (five seconds). The only valid "
+        "units are d (days), h (hours), m (minutes), and s (seconds). Units can "
+        "be repeated, for example 5s3d2s would be three days and seven (5+2) "
+        "seconds. Units can be specified in any order. To specify a backwards "
+        "offset, prefix the offset with b, for example b1d would be backwards "
+        "one day.",
+    )
+    get.add_argument(
+        "-f",
+        "--format",
+        choices=_output_formats.keys(),
+        default="long-datetime",
+        help="The output format to use. The default is long-datetime.",
+    ).completer = _output_format_completer  # ty: ignore[unresolved-attribute]
+    get.set_defaults(func=_get, **config)
+
+    in_: argparse.ArgumentParser = subparsers.add_parser(
+        "in",
+        help="Generate a timestamp relative to now.",
+        description="Generate a Discord-compatible timestamp relative to the current "
+        "time.",
+        epilog=f"Some options can be set via config file. See {dstamp.APP_NAME} "
+        "-h show-config",
+        add_help=False,
+        parents=[cli.base_parser, base],
+    )
+    in_.add_argument(
+        "offset",
+        help="An offset to apply to the current time. Examples: 1d (one day), "
+        "3h5m (three hours and five minutes), 5s (five seconds). The only valid "
+        "units are d (days), h (hours), m (minutes), and s (seconds). Units can "
+        "be repeated, for example 5s3d2s would be three days and seven (5+2) "
+        "seconds. Units can be specified in any order. To specify a backwards "
+        "offset, prefix the offset with b, for example b1d would be backwards "
+        "one day.",
+    )
+    # We duplicate the format argument because the defaults are linked if we
+    # put it in the parent parser.
+    in_.add_argument(
+        "-f",
+        "--format",
+        choices=_output_formats.keys(),
+        default="relative",
+        help="The output format to use. The default is relative.",
+    ).completer = _output_format_completer  # ty: ignore[unresolved-attribute]
+    in_.set_defaults(func=_in, **config)
+
+
+_output_formats = {
+    "short-time": ("t", "18:01"),
+    "long-time": ("T", "18:01:06"),
+    "short-date": ("d", "29/05/2026"),
+    "long-date": ("D", "29 May 2026"),
+    "short-datetime": ("f", "29 May 2026 at 18:01"),
+    "long-datetime": ("F", "Friday 29 May 2026 at 18:01"),
+    "relative": ("R", "3 minutes ago"),
+}
+
+
+def _output_format_completer(**_: Any) -> dict:  # pragma: nocover
+    return {key: "e.g. " + _output_formats[key][1] for key in _output_formats}
+
+
+def _get(args: argparse.Namespace) -> None:
+    datetime = _get_datetime(args.date, args.time)
+    logger.info(f"using datetime: {datetime}")
+
+    if args.offset:
+        datetime += parse.offset(args.offset)
+        logger.info(f"datetime after offset: {datetime}")
+
+    _show_timestamp(datetime, args)
+
+
+def _in(args: argparse.Namespace) -> None:
+    datetime = dt.datetime.now()
+    logger.info(f"using datetime: {datetime}")
+
+    datetime += parse.offset(args.offset)
+    logger.info(f"datetime after offset: {datetime}")
+
+    _show_timestamp(datetime, args)
+
+
+def _show_timestamp(datetime: dt.datetime, args: argparse.Namespace) -> None:
+    precision = parse.precision(args.precision)
+    datetime_rounded = round.datetime(datetime, precision)
+    logger.info(f"datetime after rounding: {datetime_rounded}")
+
+    format_code = _output_formats[args.format][0]
+    timestamp = discord.timestamp(datetime_rounded, format_code)
+    print(timestamp)
+
+    if args.copy:
+        pyperclip.copy(timestamp)
+        print("Copied to clipboard!")
+
+
+def _get_datetime(date: str | None, time: str | None) -> dt.datetime:
+    if not date:
+        # Use current time if neither date nor time are provided.
+        return dt.datetime.now()
+    if not time:
+        date_or_time = _parse_date_or_time(date)
+        if isinstance(date_or_time, dt.date):
+            # Use midnight if only date is provided.
+            return dt.datetime.combine(date_or_time, dt.time())
+        # Use current date if only time is provided.
+        return dt.datetime.combine(dt.date.today(), date_or_time)
+    # Note that it's not possible for time to be defined but not date because
+    # they are both optional positional arguments.
+    return dt.datetime.combine(parse.date(date), parse.time(time))
+
+
+def _parse_date_or_time(input: str) -> dt.date | dt.time:
+    try:
+        return parse.date(input)
+    except exceptions.ParserFormatError:
+        return parse.time(input)

dstamp-4/src/dstamp/subcommands/show_config.py

@@ -0,0 +1,25 @@
+"""The show-config command."""
+
+import argparse
+
+from dstamp import cli, config
+
+
+def register(subparsers: argparse._SubParsersAction) -> None:
+    """Register the show-config command as a subparser."""
+    show_config: argparse.ArgumentParser = subparsers.add_parser(
+        "show-config",
+        help="Show the default config location and exit.",
+        description="Show the default configuration file location and exit.",
+        epilog="The config file should contain valid TOML. Valid keys are copy "
+        "(bool), format (string), precision (string), quiet (bool), and verbose "
+        "(bool), which override the default values for the corresponding options "
+        "for other commands.",
+        add_help=False,
+        parents=[cli.base_parser],
+    )
+    show_config.set_defaults(func=_show_config)
+
+
+def _show_config(_: argparse.Namespace) -> None:
+    print(config.default_path())

dstamp-4/src/dstamp/subcommands/show_log.py

@@ -0,0 +1,21 @@
+"""The show-log command."""
+
+import argparse
+
+from dstamp import cli, logging
+
+
+def register(subparsers: argparse._SubParsersAction) -> None:
+    """Register the show-log command as a subparser."""
+    show_config: argparse.ArgumentParser = subparsers.add_parser(
+        "show-log",
+        help="Show the log location and exit.",
+        description="Show the default logfile location and exit.",
+        add_help=False,
+        parents=[cli.base_parser],
+    )
+    show_config.set_defaults(func=_show_log)
+
+
+def _show_log(_: argparse.Namespace) -> None:
+    print(logging.LOG_DIR)

dstamp-3/src/dstamp/cli.py

@@ -1,53 +0,0 @@
-# PYTHON_ARGCOMPLETE_OK
-"""Dstamp's CLI interface."""
-
-import argparse
-from collections.abc import Iterable
-
-import argcomplete
-
-from dstamp import exceptions, subcommands
-
-
-def construct_parser() -> argparse.ArgumentParser:
-    """Create the dstamp CLI argument parser."""
-    # Add the help option manually so we can change the help message.
-    parser = argparse.ArgumentParser(
-        add_help=False,
-        description="Discord timestamp generator",
-    )
-    parser.add_argument(
-        "-h",
-        "--help",
-        action="store_true",
-        help="Show this help message and exit. For command-specific help, use "
-        "%(prog)s -h COMMAND",
-    )
-    parser.set_defaults(print_help=parser.print_help)
-    parser.add_argument(
-        "--version",
-        action="version",
-        version="%(prog)s 3",
-        help="Show version number and exit",
-    )
-
-    subparsers = parser.add_subparsers(title="commands")
-    subcommands.register_all(subparsers)
-
-    return parser
-
-
-def run(args: Iterable[str] | None = None) -> None:
-    """Parse `args` as CLI arguments and execute the resulting command."""
-    parser = construct_parser()
-    argcomplete.autocomplete(parser)
-    parsed_args = parser.parse_args(args)
-
-    if not hasattr(parsed_args, "func") or parsed_args.help:
-        parsed_args.print_help()
-        return
-
-    try:
-        parsed_args.func(parsed_args)
-    except exceptions.DstampError as e:
-        parser.error(str(e))

dstamp-3/src/dstamp/config.py

@@ -1,46 +0,0 @@
-"""Config file utilities.
-
-The functions in this module do not create a config file if one does not exist.
-"""
-
-import pathlib
-import tomllib
-import warnings
-
-import platformdirs
-
-_APP_NAME = "dstamp"
-
-
-def default_path() -> pathlib.Path:
-    """Return the default config file path.
-
-    Note that the file does not necessarily exist.
-    """
-    config_dir = platformdirs.user_config_path(_APP_NAME)
-    return config_dir / "config.toml"
-
-
-_VALID_KEYS = {
-    "copy",
-    "format",
-    "precision",
-}
-
-
-def parse(path: pathlib.Path) -> dict:
-    """Parse `path` as a config file and return the corresponding defaults dict.
-
-    If `path` does not exist, it is treated as if it were an empty file.
-    """
-    if not path.exists():
-        return {}
-
-    config = tomllib.loads(path.read_text())
-
-    if unknown_keys := config.keys() - _VALID_KEYS:
-        warnings.warn(
-            f"unknown keys in config file: {', '.join(unknown_keys)}", stacklevel=2
-        )
-
-    return config

dstamp-3/src/dstamp/subcommands/__init__.py

@@ -1,14 +0,0 @@
-"""Dstamp subcommands."""
-
-import argparse
-
-from . import get, show_config
-
-
-def register_all(subparsers: argparse._SubParsersAction) -> None:
-    """Register all subcommands as subparsers."""
-    get.register(subparsers)
-    show_config.register(subparsers)
-
-
-__all__ = ["register_all"]

dstamp-3/src/dstamp/subcommands/get.py

@@ -1,124 +0,0 @@
-"""The get timestamp command."""
-
-import argparse
-import datetime as dt
-
-import pyperclip
-
-from dstamp import config, discord, exceptions, parse, round
-
-
-def register(subparsers: argparse._SubParsersAction) -> None:
-    """Register the get command as a subparser."""
-    get: argparse.ArgumentParser = subparsers.add_parser(
-        "get",
-        help="Generate a timestamp",
-        description="Generate a Discord-compatible timestamp",
-        epilog="Some options can be set via config file. See %(prog)s -h show-config",
-        add_help=False,
-    )
-    get.add_argument(
-        "date",
-        nargs="?",
-        help="Examples: 1jan2025, 30may2020, 6jun. If the year is omitted, the "
-        "current year is used. If the entire date is omitted, the current date "
-        "is used. Accepts special keywords: today, tomorrow, tmrw, yesterday",
-    )
-    get.add_argument(
-        "time",
-        nargs="?",
-        help="Examples: 1, 15, 1730, 35004pm. If omitted, midnight is used. If "
-        "the date is also omitted, the current time is used instead. Can be "
-        "provided even if the date is omitted. Accepts special keywords: now "
-        "(current time), midnight, noon",
-    )
-    get.add_argument(
-        "-c",
-        "--copy",
-        action=argparse.BooleanOptionalAction,
-        default=True,
-        help="If set, copy the result to clipboard. Enabled by default",
-    )
-    get.add_argument(
-        "-f",
-        "--format",
-        choices=_format_codes.keys(),
-        default="long-datetime",
-        help="The output format to use. The default is long-datetime",
-    )
-    get.add_argument(
-        "-o",
-        "--offset",
-        help="An offset to apply to the date and time. Examples: 1d (one day), "
-        "3h5m (three hours and five minutes), 5s (five seconds). The only valid "
-        "units are d (days), h (hours), m (minutes), and s (seconds). Units can "
-        "be repeated, for example 5s3d2s would be three days and seven (5+2) "
-        "seconds. Units can be specified in any order. To specify a backwards "
-        "offset, prefix the offset with b, for example b1d would be backwards "
-        "one day",
-    )
-    get.add_argument(
-        "-p",
-        "--precision",
-        default="1s",
-        help="The precision to which the date and time should be rounded. "
-        "Examples: 1s, 30m, 2h, 24h, 60s, 60m. The only valid units are h "
-        "(hours), m (minutes), and s (seconds). The quantity must be a factor "
-        "of 60 (minutes or seconds) or 24 (hours). The default is 1s",
-    )
-    get.set_defaults(
-        print_help=get.print_help,
-        func=_get,
-        **config.parse(config.default_path()),
-    )
-
-
-_format_codes = {
-    "short-time": "t",
-    "long-time": "T",
-    "short-date": "d",
-    "long-date": "D",
-    "short-datetime": "f",
-    "long-datetime": "F",
-    "relative": "R",
-}
-
-
-def _get(args: argparse.Namespace) -> None:
-    datetime = _get_datetime(args.date, args.time)
-
-    if args.offset:
-        datetime += parse.offset(args.offset)
-
-    precision = parse.precision(args.precision)
-    datetime_rounded = round.datetime(datetime, precision)
-
-    timestamp = discord.timestamp(datetime_rounded, _format_codes[args.format])
-    print(timestamp)
-
-    if args.copy:
-        pyperclip.copy(timestamp)
-        print("Copied to clipboard!")
-
-
-def _get_datetime(date: str | None, time: str | None) -> dt.datetime:
-    if not date:
-        # Use current time if neither date nor time are provided.
-        return dt.datetime.now()
-    if not time:
-        date_or_time = _parse_date_or_time(date)
-        if isinstance(date_or_time, dt.date):
-            # Use midnight if only date is provided.
-            return dt.datetime.combine(date_or_time, dt.time())
-        # Use current date if only time is provided.
-        return dt.datetime.combine(dt.date.today(), date_or_time)
-    # Note that it's not possible for time to be defined but not date because
-    # they are both optional positional arguments.
-    return dt.datetime.combine(parse.date(date), parse.time(time))
-
-
-def _parse_date_or_time(input: str) -> dt.date | dt.time:
-    try:
-        return parse.date(input)
-    except exceptions.ParserFormatError:
-        return parse.time(input)

dstamp-3/src/dstamp/subcommands/show_config.py

@@ -1,23 +0,0 @@
-"""The get timestamp command."""
-
-import argparse
-
-from dstamp import config
-
-
-def register(subparsers: argparse._SubParsersAction) -> None:
-    """Register the get command as a subparser."""
-    show_config: argparse.ArgumentParser = subparsers.add_parser(
-        "show-config",
-        help="Show the default config location and exit",
-        description="Show the default configuration file location and exit",
-        epilog="The config file should contain valid TOML. Valid keys are copy "
-        "(bool), format (string), and precision (string), which override the "
-        "default values for the corresponding options for other commands.",
-        add_help=False,
-    )
-    show_config.set_defaults(print_help=show_config.print_help, func=_show_config)
-
-
-def _show_config(_: argparse.Namespace) -> None:
-    print(config.default_path())