Description

jonathan-geoseer

opened on May 1, 2024

Issue body actions

https://docs.python.org/3/library/sqlite3.html - does not have any documentation for sqlite3.Binary() method

Linked PRs

• gh-118469: Document sqlite3 PEP-249 constructors #118975
• gh-118469: Add documentation for sqlite3 PEP-249 constructors #122091
• gh-118469: Document sqlite3.Binary #122343
• gh-118469: Document sqlite3.Binary in module constants #136734

Activity

1. jonathan-geoseer

   added

   docsDocumentation in the Doc dirDocumentation in the Doc dir

   on May 1, 2024
2. AlexWaygood

   added

   topic-sqlite3

   on May 1, 2024
3. erlend-aasland commented on May 1, 2024

   

   erlend-aasland

   on May 1, 2024

   Contributor

   More actions

   Binary() is a part of PEP-249; see https://peps.python.org/pep-0249/#binary

   Note that the other PEP-249 constructors are not documented either:

   • Date()
   • Time()
   • Timestamp()
   • DateFromTicks()
   • TimeFromTicks()
   • TimestampFromTicks()
4. erlend-aasland

   added

   easy

   on May 1, 2024
5. firatv commented on May 3, 2024

   

   firatv

   on May 3, 2024

   More actions

   Hello,

   A bit of background: I've been learning programming for a few years now. I developed and keep developing projects of my own using mainly shell, C and Python (hosted in gitlab). I want to become an active contributor in the FOSS ecosystem, and I believe Python would be a good place to start. So I searched issues with an 'easy' tag and found this one. I'm familiar with reST and SQL at a beginner level, and I'm learning sqlite3 for my own projects. I set up my development environment as directed in the devguide, built python and its documentation, and ran all the tests.

   Now back to the issue at hand: I looked at PEP-249, the documentation for sqlite and its module, and found Lib/sqlite3/dbapi2.py. However, I don't know where to go from here. I'm eager to learn and would be glad if given directions.

   Thank you for your time.
6. erlend-aasland commented on May 7, 2024

   

   erlend-aasland

   on May 7, 2024

   Contributor

   More actions

   I'm eager to learn and would be glad if given directions.

   Great; first, take a look at the devguide section for documentation:

   • https://devguide.python.org/documentation/

   I also encourage taking a look at our documentation north star, Diátaxis: https://diataxis.fr

   The missing documentation should be added to the file Doc/library/sqlite3.rst in the CPython repo. IMO, the missing constructors should be documented under the Module functions header (between line 259 and line 425 in Doc/library/sqlite3.rst). I suggest to add them at the end of that section.

   Shout out if you need more info :)

   Reacted by Daniel Hollas and 3willows
7. firatv commented on May 11, 2024

   

   firatv

   on May 11, 2024

   More actions

   Thank you :) Now I have a clear map in my head and explored most of it. Started implementing. I'll have a pull request by Monday.

   Reacted by Erlend E. Aasland
8. firatv

   added 3 commits that reference this issue on May 12, 2024

   pythongh-118469: Add `Date`, `Time` and `Timestamp` constructors.

   ef0bc3e

   pythongh-118469: Add `DateFromTicks`, `TimeFromTicks` and `TimestampF…

   4c89b2c

   pythongh-118469: Add `Binary` constructor.

   e73461a
9. dave-r12

   added 5 commits that reference this issue on Jul 20, 2024

   pythonGH-118469: Add documentation for sqlite3 PEP-249 constructors

   d45b9c0

   pythongh-118469: Add documentation for sqlite3 PEP-249 constructors

   e43b91b

   pythongh-118469: Add documentation for sqlite3 PEP-249 constructors

   53c9289

   pythongh-118469: Add documentation for sqlite3 PEP-249 constructors

   d1337e5

   pythongh-118469: Add documentation for sqlite3 PEP-249 constructors

   d64fe19
10. Adityacode-hub commented on Feb 11, 2025

    

    Adityacode-hub

    on Feb 11, 2025

    More actions

    i am also interested in solving this issue #118469
11. killerdevildog

    added 2 commits that reference this issue on Jul 17, 2025

    pythongh-118469: Document sqlite3.Binary in module constants

    5abaa38

    pythongh-118469: Document sqlite3.Binary in module constants

    617a148
12. StanFromIreland

    added this to sqlite3 issueson Sep 28, 2025
13. StanFromIreland

    moved this to TODO: Docs in sqlite3 issueson Sep 28, 2025
14. k4ran909 commented on Jun 29, 2026

    

    k4ran909

    on Jun 29, 2026 · Hidden as duplicate

    show commentMore actions

Issue actions