Skip to main content

My utility functions

Project description

argel1200.utilities

A small collection of utility functions that help reduce boilerplate code.

Version 1.3.0+ now spreads dependencies across files, so you can use e.g., open_file without having click and dumper installed.

Dumper Utilties

dumps

Wrapper for dumper, to make it eaier to get Perl style Data Dumper output. Assumes you want strings back, and leverages get_variable_name to pull the calling function.

get_variable_name

Helper function used by dumps. Perl's Data::Dumper gives variable_name=value output. This seeks to mimic that.

Class Utilties

import_class_from_string

Useful when you need to (or it's just more elegant to) dynamically determine the class based on a string that you are obtaining dynamically at runtime. Useful if you have a base class and multiple subclasses. Very useful if you want to build out your classes as needed (something can just be a base class now, then later on you could create a sub class for it and your script will start loading it as the new sub class automatically)

Logging Utilties

add_logging_level

Add custom logging levels

logging_init

Uses haggis.logs to add two additional "debug" logging levels: 'TRACE' and 'MEMDUMP' and initializes a logging instance if return_logger is True.

log_or_print

Streamlines if logger log.level else print workflows.

File Utilities

open_file

Wrapper for opening a file that provides basic error handling. Get those try blocks out of your script!

Command-line Utilties

process_cli_using_click

Useful if you want to use click in standalone=False mode. Provides basic error handling (required for standalone=False)


History

1.3.0

  • Restructured so that people can use e.g. open_file without having to install click or dumper. -- Pulling some tricks in utilities/init.py to maintain backwards compatibility.

1.2.0

  • Added my own add_log_level that supports Python 3.13. Used to use Haggis for this, but it's using old methods that no longer work.
  • Improved open_file to check for permissions and tries to catch if a file is open on Windows
  • Added log_or_print

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

argel1200-1.3.0.tar.gz (6.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

argel1200-1.3.0-py3-none-any.whl (8.7 kB view details)

Uploaded Python 3

File details

Details for the file argel1200-1.3.0.tar.gz.

File metadata

  • Download URL: argel1200-1.3.0.tar.gz
  • Upload date:
  • Size: 6.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.5 CPython/3.12.3 Windows/11

File hashes

Hashes for argel1200-1.3.0.tar.gz
Algorithm Hash digest
SHA256 036a4c58ea57ee70716c1dedc6ac012e0501834cd081dc03f2ec11851660adf2
MD5 646ff2da57af0c7c461177d4a9b4c556
BLAKE2b-256 6b577ef9eaa889700cef21ec23b811c47afe738454ecb8e77192664431244e43

See more details on using hashes here.

File details

Details for the file argel1200-1.3.0-py3-none-any.whl.

File metadata

  • Download URL: argel1200-1.3.0-py3-none-any.whl
  • Upload date:
  • Size: 8.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.5 CPython/3.12.3 Windows/11

File hashes

Hashes for argel1200-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b8ccd4cf13bf161ac9fdafc87fd9281561e65d03c0461b2f12b19d52a6b2d374
MD5 346478a3a3e3f9cd75b94a04ca470c06
BLAKE2b-256 3793c105a7a6276476757d421f2dd486765ecf2c73de4f227f3c5d2f3c8b8852

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page