Copy page

• Copy page
• View source

stouputils package

Stouputils is a collection of utility modules designed to simplify and enhance the development process. It includes a range of tools for tasks such as execution of doctests, display utilities, decorators, as well as context managers.

Check the documentation for more details: https://stoupy51.github.io/stouputils/

Subpackages

• stouputils.all_doctests package
  • Submodules
    • stouputils.all_doctests.launch module
      • launch_tests()
    • stouputils.all_doctests.reexports module
      • module_public_names()
      • find_missing_reexports()
    • stouputils.all_doctests.utils module
      • test_module_with_progress()
• stouputils.applications package
  • Subpackages
    • stouputils.applications.automatic_docs package
      • Subpackages
      • Submodules
    • stouputils.applications.upscaler package
      • Submodules
• stouputils.archive package
  • Subpackages
    • stouputils.archive.repair package
      • Submodules
  • Submodules
    • stouputils.archive.cli module
      • archive_cli()
    • stouputils.archive.creation module
      • make_archive()
• stouputils.backup package
  • Submodules
    • stouputils.backup.cli module
      • backup_cli()
    • stouputils.backup.consolidate module
      • consolidate_backups()
    • stouputils.backup.create module
      • create_delta_backup()
    • stouputils.backup.hash module
      • get_file_hash()
      • extract_hash_from_zipinfo()
    • stouputils.backup.limiter module
      • limit_backups()
    • stouputils.backup.retrieve module
      • get_backup_sort_key()
      • get_all_previous_backups()
      • is_file_in_any_previous_backup()
• stouputils.check package
  • Submodules
    • stouputils.check.cli module
      • BANNED_CHARACTERS
      • check_cli()
      • expand_paths()
      • check_file()
    • stouputils.check.python module
      • CLAUSE_ENDINGS
      • CLAUSE_BOUNDARY
      • NEW_ITEM
      • EXAMPLES_HEADER
      • TYPED_ARGUMENT
      • SPAN_DELIMITERS
      • STRANDED_FRAGMENT
      • SUPPRESSION
      • LAYOUT_TOKENS
      • python_errors()
      • suppressions()
      • statements()
      • indentation_errors()
      • tab_aligned_lines()
      • string_content_lines()
      • comment_errors()
      • docstring_layout_errors()
      • constant_errors()
      • is_docstring()
      • docstring_errors()
      • split_spans()
      • code_block_indent()
      • strands_fragment()
    • stouputils.check.rules module
      • RULES
      • Violation
      • Suppression
      • CheckConfig
• stouputils.collections package
  • Submodules
    • stouputils.collections.dataframe module
      • upsert_in_dataframe()
    • stouputils.collections.iterable module
      • unique_list()
      • at_least_n()
    • stouputils.collections.registry module
      • Registry
    • stouputils.collections.shuffle module
      • affine_permutation_generator()
      • feistel_permutation_generator()
      • FeistelHelpers
    • stouputils.collections.sorting module
      • sort_dict_keys()
• stouputils.compression package
  • Submodules
    • stouputils.compression.deadband module
      • METRIC_DEADBAND
      • MetricCurve
      • DeadbandFilter
• stouputils.continuous_delivery package
  • Submodules
    • stouputils.continuous_delivery.cd_utils module
      • parse_commit_message()
      • format_changelog()
      • load_credentials()
      • handle_response()
      • clean_version()
      • version_to_float()
    • stouputils.continuous_delivery.git module
      • run_git_command()
      • get_local_tags()
      • get_latest_tag()
      • get_commits_since_tag()
      • get_commits_since_date()
      • get_commits_since_commit()
      • parse_date_fallback()
      • parse_commit_log()
      • get_remotes()
      • parse_remote_url()
      • detect_host_type()
      • create_url_formatter()
      • generate_local_changelog()
      • changelog_cli()
    • stouputils.continuous_delivery.github module
      • UPLOAD_ATTEMPTS
      • UPLOAD_RETRY_DELAY
      • validate_github_credentials()
      • validate_github_config()
      • build_github_config()
      • delete_github_release()
      • delete_github_tag()
      • get_github_sha()
      • get_github_commit_date()
      • extract_github_commit_data()
      • get_pushed_head_sha()
      • create_github_tag()
      • create_github_release()
      • upload_github_assets()
      • upload_to_github()
    • stouputils.continuous_delivery.gitlab module
      • validate_gitlab_credentials()
      • validate_gitlab_config()
      • build_gitlab_config()
      • delete_gitlab_release()
      • delete_gitlab_tag()
      • get_gitlab_sha()
      • get_gitlab_commit_date()
      • extract_gitlab_commit_data()
      • create_gitlab_tag()
      • create_gitlab_release()
      • upload_gitlab_assets()
      • upload_to_gitlab()
    • stouputils.continuous_delivery.pypi module
      • update_pip_and_required_packages()
      • build_package()
      • upload_package()
      • pypi_full_routine()
      • pypi_full_routine_using_uv()
    • stouputils.continuous_delivery.pyproject module
      • read_pyproject()
      • format_toml_lists()
      • write_pyproject()
      • increment_version_from_input()
      • increment_version_from_pyproject()
      • get_version_from_pyproject()
    • stouputils.continuous_delivery.release_common module
      • PlatformConfig
      • validate_required_keys()
      • check_existing_tag()
      • prompt_delete_existing()
      • handle_existing_tag()
      • fetch_latest_tag()
      • paginate_api()
      • fetch_commits_since_tag()
      • generate_changelog()
      • upload_files()
      • log_success()
      • delete_resource()
      • delete_resource_unconditional()
      • create_tag_on_branch()
      • create_release()
      • publish_release()
• stouputils.ctx package
  • Submodules
    • stouputils.ctx.common module
      • AbstractBothContextManager
    • stouputils.ctx.do_nothing module
      • DoNothing
      • NullContextManager
    • stouputils.ctx.log_to_file module
      • LogToFile
    • stouputils.ctx.measure_time module
      • MeasureTime
    • stouputils.ctx.muffle module
      • ErrorLevelDetector
      • Muffle
    • stouputils.ctx.set_mp_start_method module
      • SetMPStartMethod
• stouputils.decorators package
  • Submodules
    • stouputils.decorators.abstraction module
      • abstract()
    • stouputils.decorators.caching module
      • ALL_CACHES
      • MISSING
      • KWARGS_MARKER
      • clear_simple_caches()
      • simple_cache()
    • stouputils.decorators.common module
      • WRAPPED_ATTRIBUTE
      • safe_wraps()
      • get_function_name()
      • get_wrapper_name()
      • set_wrapper_name()
    • stouputils.decorators.deprecation module
      • deprecated()
    • stouputils.decorators.error_handling module
      • LogLevels
      • handle_error()
    • stouputils.decorators.retrying module
      • retry()
    • stouputils.decorators.silencing module
      • silent()
    • stouputils.decorators.timeouts module
      • timeout()
    • stouputils.decorators.timing module
      • measure_time()
• stouputils.image package
  • Submodules
    • stouputils.image.colors module
      • relative_luminance()
      • readable_text_color()
    • stouputils.image.cropping module
      • T
      • auto_crop()
    • stouputils.image.gif_export module
      • numpy_to_gif()
    • stouputils.image.obj_export module
      • extract_verts_faces_from_segment()
      • numpy_to_obj()
    • stouputils.image.resize module
      • image_resize()
    • stouputils.image.segments_export module
      • add_default_colors_to_segments()
      • numpy_segments_to_obj()
• stouputils.installer package
  • Submodules
    • stouputils.installer.common module
      • prompt_for_path()
      • ask_install_type()
    • stouputils.installer.downloader module
      • download_executable()
      • check_executable()
    • stouputils.installer.linux module
      • add_to_path_linux()
      • check_admin_linux()
      • get_install_path_linux()
    • stouputils.installer.main module
      • extract_archive()
      • get_install_path()
      • add_to_path()
      • install_program()
    • stouputils.installer.windows module
      • add_to_path_windows()
      • check_admin_windows()
      • get_install_path_windows()
• stouputils.io package
  • Submodules
    • stouputils.io.csv module
      • csv_dump()
      • csv_load()
    • stouputils.io.json module
      • json_dump()
      • json_load()
    • stouputils.io.path module
      • get_root_path()
      • relative_path()
      • super_copy()
      • super_open()
      • read_file()
      • replace_tilde()
      • clean_path()
    • stouputils.io.redirect module
      • is_junction()
      • create_junction()
      • create_bind_mount()
      • copytree_with_progress()
      • redirect_folder()
      • redirect_cli()
    • stouputils.io.utils module
      • safe_close()
• stouputils.lock package
  • Usage
  • Submodules
    • stouputils.lock.base module
      • _lock_fd()
      • _unlock_fd()
      • _remove_file_if_unlocked()
      • _worker()
      • _hold()
      • LockFifo
    • stouputils.lock.queue module
      • BaseTicketQueue
      • FileTicketQueue
      • RedisTicketQueue
    • stouputils.lock.re_entrant module
      • RLockFifo
    • stouputils.lock.redis_fifo module
      • RedisLockFifo
    • stouputils.lock.shared module
      • LockError
      • LockTimeoutError
      • resolve_path()
      • resolve_acquire_defaults()
• stouputils.mlflow package
  • Submodules
    • stouputils.mlflow.process_metrics_monitor module
      • ProcessMetricsMonitor
• stouputils.parallel package
  • Submodules
    • stouputils.parallel.capturer module
      • PipeWriter
      • CaptureOutput
    • stouputils.parallel.common module
      • nice_wrapper()
      • set_process_priority()
      • starmap()
      • delayed_call()
      • resolve_process_title()
      • handle_parameters()
      • normalize_parallel_params()
      • run_sequential()
    • stouputils.parallel.multi module
      • multiprocessing()
      • multithreading()
      • capture_subprocess_output()
      • process_title_wrapper()
    • stouputils.parallel.subprocess module
      • RemoteSubprocessError
      • run_in_subprocess()
      • _subprocess_wrapper()
• stouputils.print package
  • Submodules
    • stouputils.print.color_formatting module
      • format_colored()
      • colored()
    • stouputils.print.colorizer module
      • WordColorizer
    • stouputils.print.common module
      • PrintMemory
    • stouputils.print.debugging module
      • whatisit()
      • breakpoint()
    • stouputils.print.message module
      • info()
      • debug()
      • alt_debug()
      • suggestion()
      • progress()
      • warning()
      • error()
    • stouputils.print.output_stream module
      • TeeMultiOutput
    • stouputils.print.progress_tqdm module
      • progress_bar()
    • stouputils.print.utils module
      • remove_colors()
      • remove_ansi()
      • is_same_print()
      • current_time()
• stouputils.typing package
  • Submodules
    • stouputils.typing.aliases module
      • JsonDict
      • JsonList
      • JsonMap
      • JsonMutMap
      • IterAny
      • CallableAny
      • ClassInfo
    • stouputils.typing.extension_points module
      • INHERITABLE_ATTRIBUTE
      • OVERRIDABLE_ATTRIBUTE
      • HOOK_ATTRIBUTE
      • ClassMember
      • inheritable()
      • overridable()
      • hook()
      • set_member_flag()
    • stouputils.typing.runtime module
      • is_generic_instance()
      • is_sequence()
      • convert_to_serializable()

Submodules

• stouputils.__main__ module
• stouputils._deprecated module
  • super_csv_dump()
  • super_csv_load()
  • super_json_dump()
  • super_json_load()
  • colored_for_loop()
• stouputils.config module
  • StouputilsConfig
    • StouputilsConfig.VERBOSE_READING_ENV
    • StouputilsConfig.RESET
    • StouputilsConfig.BLACK
    • StouputilsConfig.LIGHT_GRAY
    • StouputilsConfig.GRAY
    • StouputilsConfig.RED
    • StouputilsConfig.GREEN
    • StouputilsConfig.YELLOW
    • StouputilsConfig.BLUE
    • StouputilsConfig.MAGENTA
    • StouputilsConfig.CYAN
    • StouputilsConfig.WHITE
    • StouputilsConfig.LINE_UP
    • StouputilsConfig.BOLD
    • StouputilsConfig.BAR_FORMAT
    • StouputilsConfig.FORCE_RAISE_EXCEPTION
    • StouputilsConfig.CPU_COUNT
    • StouputilsConfig.MEMORY_MEGABYTES
    • StouputilsConfig.PROCESS_TITLE_PER_WORKER
    • StouputilsConfig.CHUNK_SIZE
    • StouputilsConfig.LARGE_CHUNK_SIZE
    • StouputilsConfig.COMMIT_TYPES
    • StouputilsConfig.AUTO_DOCS_REQUIREMENTS
    • StouputilsConfig.SEGMENTS_UNIQUE_COLOR
    • StouputilsConfig.SEGMENTS_COLOR_CYCLE
• stouputils.lazy module
  • AlwaysLazy
  • ALWAYS_LAZY
• stouputils.system module
  • CPU_MAX_PATH
  • MEMORY_MAX_PATH
  • MEMINFO_PATH
  • MEGABYTE
  • cpu_limit()
  • memory_limit_megabytes()
  • parse_cpu_max()
  • parse_memory_max()
  • parse_meminfo_total()
  • read_limit_file()
• stouputils.version_pkg module
  • VersionPrinter
    • VersionPrinter.main_package
    • VersionPrinter.primary_color
    • VersionPrinter.secondary_color
    • VersionPrinter.max_depth
    • VersionPrinter.fully_displayed
    • VersionPrinter.version_of()
    • VersionPrinter.dependency_name()
    • VersionPrinter.dependencies_of()
    • VersionPrinter.separators()
    • VersionPrinter.minimum_width
    • VersionPrinter.package_line()
    • VersionPrinter.already_shown_line()
    • VersionPrinter.indent_block()
    • VersionPrinter.render_tree()
    • VersionPrinter.print_tree()
    • VersionPrinter.print_flat()
    • VersionPrinter.show()
  • show_version()
  • show_version_cli()