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.applications package
  • Subpackages
    • stouputils.applications.upscaler package
      • Submodules
  • Submodules
    • stouputils.applications.automatic_docs module
      • REQUIREMENTS
      • check_dependencies()
      • get_sphinx_conf_content()
      • get_versions_from_github()
      • markdown_to_rst()
      • generate_index_rst()
      • generate_documentation()
      • generate_redirect_html()
      • update_documentation()
• stouputils.continuous_delivery package
  • Submodules
    • stouputils.continuous_delivery.cd_utils module
      • load_credentials()
      • handle_response()
      • clean_version()
      • version_to_float()
    • stouputils.continuous_delivery.github module
      • validate_credentials()
      • validate_config()
      • handle_existing_tag()
      • delete_existing_release()
      • delete_existing_tag()
      • get_latest_tag()
      • get_commits_since_tag()
      • generate_changelog()
      • create_tag()
      • create_release()
      • upload_assets()
      • upload_to_github()
    • 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.stubs module
      • generate_stubs()
      • clean_stubs_directory()
      • stubs_full_routine()
• stouputils.data_science namespace
  • Subpackages
    • stouputils.data_science.config namespace
      • Submodules
    • stouputils.data_science.data_processing namespace
      • Subpackages
      • Submodules
    • stouputils.data_science.dataset package
      • Submodules
    • stouputils.data_science.models namespace
      • Subpackages
      • Submodules
    • stouputils.data_science.scripts namespace
      • Submodules
  • Submodules
    • stouputils.data_science.metric_dictionnary module
    • stouputils.data_science.metric_utils module
      • MetricUtils
    • stouputils.data_science.mlflow_utils module
      • get_artifact_path()
      • get_weights_path()
      • get_runs_by_experiment_name()
      • get_runs_by_model_name()
      • log_history()
      • start_run()
      • get_best_run_by_metric()
      • load_model()
    • stouputils.data_science.range_tuple module
      • _RangeTupleBase
      • RangeTuple
    • stouputils.data_science.utils module
      • Utils
• 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.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()
• stouputils.parallel package
  • Submodules
    • stouputils.parallel.capturer module
      • PipeWriter
      • CaptureOutput
    • stouputils.parallel.common module
      • nice_wrapper()
      • set_process_priority()
      • starmap()
      • delayed_call()
      • handle_parameters()
    • stouputils.parallel.multi module
      • multiprocessing()
      • multithreading()
      • capture_subprocess_output()
    • stouputils.parallel.subprocess module
      • RemoteSubprocessError
      • run_in_subprocess()
      • _subprocess_wrapper()

Submodules

• stouputils.__main__ module
• stouputils._deprecated module
  • super_csv_dump()
  • super_csv_load()
  • super_json_dump()
  • super_json_load()
• stouputils.all_doctests module
  • launch_tests()
  • test_module_with_progress()
• stouputils.archive module
  • repair_zip_file()
  • make_archive()
  • archive_cli()
• stouputils.backup module
  • backup_cli()
  • create_delta_backup()
  • consolidate_backups()
  • limit_backups()
  • get_file_hash()
  • extract_hash_from_zipinfo()
  • get_all_previous_backups()
  • is_file_in_any_previous_backup()
• stouputils.collections module
  • unique_list()
  • at_least_n()
  • sort_dict_keys()
  • upsert_in_dataframe()
  • array_to_disk()
• stouputils.ctx module
  • AbstractBothContextManager
    • AbstractBothContextManager._abc_impl
  • LogToFile
    • LogToFile.path
    • LogToFile.mode
    • LogToFile.encoding
    • LogToFile.tee_stdout
    • LogToFile.tee_stderr
    • LogToFile.ignore_lineup
    • LogToFile.restore_on_exit
    • LogToFile.file
    • LogToFile.original_stdout
    • LogToFile.original_stderr
    • LogToFile.change_file()
    • LogToFile.common()
    • LogToFile._abc_impl
  • MeasureTime
    • MeasureTime.print_func
    • MeasureTime.message
    • MeasureTime.perf_counter
    • MeasureTime.ns
    • MeasureTime.start_ns
    • MeasureTime._abc_impl
  • Muffle
    • Muffle.mute_stderr
    • Muffle.original_stdout
    • Muffle.original_stderr
    • Muffle._abc_impl
  • DoNothing
    • DoNothing._abc_impl
  • NullContextManager
  • SetMPStartMethod
    • SetMPStartMethod._abc_impl
    • SetMPStartMethod.start_method
    • SetMPStartMethod.old_method
• stouputils.decorators module
  • measure_time()
  • LogLevels
    • LogLevels.NONE
    • LogLevels.WARNING
    • LogLevels.WARNING_TRACEBACK
    • LogLevels.ERROR_TRACEBACK
    • LogLevels.RAISE_EXCEPTION
  • force_raise_exception
  • handle_error()
  • timeout()
  • retry()
  • simple_cache()
  • abstract()
  • deprecated()
  • silent()
  • _get_func_name()
  • _get_wrapper_name()
• stouputils.image module
  • image_resize()
  • auto_crop()
  • numpy_to_gif()
  • numpy_to_obj()
• stouputils.io module
  • get_root_path()
  • relative_path()
  • json_dump()
  • json_load()
  • csv_dump()
  • csv_load()
  • super_copy()
  • super_open()
  • read_file()
  • replace_tilde()
  • clean_path()
  • safe_close()
• stouputils.print module
  • colored_for_loop()
  • format_colored()
  • colored()
  • info()
  • debug()
  • alt_debug()
  • suggestion()
  • progress()
  • warning()
  • error()
  • whatisit()
  • breakpoint()
  • TeeMultiOutput
    • TeeMultiOutput.files
    • TeeMultiOutput.strip_colors
    • TeeMultiOutput.ascii_only
    • TeeMultiOutput.ignore_lineup
    • TeeMultiOutput.encoding
    • TeeMultiOutput.write()
    • TeeMultiOutput.flush()
    • TeeMultiOutput.fileno()
  • remove_colors()
  • is_same_print()
  • current_time()
• stouputils.typing module
  • JsonDict
  • JsonList
  • JsonMap
  • MutJsonMap
  • convert_to_serializable()
• stouputils.version_pkg module
  • show_version()
  • show_version_cli()