Project

General

Profile

Actions
Copy link

Idea #21935

open

Identify the public API of the Python SDK and make a plan to hide non-public stuff in an internal module

Added by Peter Amstutz 6 days ago. Updated 1 day ago.

Status:
New
Priority:
Normal
Assigned To:
-
Category:
SDKs
Target version:
Development 2024-07-24 sprint
Start date:
Due date:
Story points:
-
Release:
Arvados 3.0
Release relationship:
Auto

Description

Proposed:

  • arvados.cache has a single class, merge it into arvados.api. (I believe we can maintain backwards compatibility by saying cache = api inside arvados/__init__.py.)
  • Ditto arvados.safeapi.
  • Move the following modules wholesale into arvados._internal, removing leading underscore as needed:
    • arvados.diskcache
    • arvados.http_to_keep
    • arvados.retry
    • arvados.timer (maybe just move this class to arvados._internal since it's so small?)
    • arvados._normalize_stream
    • arvados._pycurlhelper
    • arvados._ranges
  • In arvados.util:
    • deprecated moves to arvados._internal
    • All the _BaseDir* classes move to arvados._internal.basedirs
Actions
Copy link

Also available in: Atom PDF