scylladb / scylladb/python-rs-driver

Reorganize public modules around driver concepts

Open
#168 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
6
Forks
7
Avg merge
5d 13h
Merged PRs (30d)
9

Description

Current public module layout is based partly on implementation details rather than user-facing concepts.

Examples:

  • scylla.enums contains both enums and non-enum configuration objects.
  • scylla.types contains only the Unset sentinel.
  • scylla.value contains only CqlEmpty.
  • scylla.session_builder and scylla.execution_profile create modules around individual implementation classes.
  • CQL type descriptors live under scylla.cluster.metadata.
  • scylla.policies re-exports many unrelated policy APIs.

This causes several problems:

  • Users must know how an object is implemented to find it.
  • Related concepts are spread across unrelated modules.
  • Generic modules such as enums, types, and value become ambiguous.
  • Changing an enum into another representation would unnecessarily affect its import location.
  • Empty root exports force verbose and difficult-to-discover imports.

Public modules should describe driver concepts and remain stable even when internal representations change.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by mapping the public exports and relationships among scylla.enums, scylla.types, scylla.value, scylla.session_builder, scylla.execution_profile, scylla.cluster.metadata, and scylla.policies. Done means related driver concepts have discoverable public modules, root exports are useful, and imports remain stable when internal representations change.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
backend-api-design
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.