Typed interface stubs for Pythonista iOS

Last update: Jul 14, 2020

Overview

Pythonista Stubs

Stubs for the Pythonista iOS API. This allows for better error detection and IDE / editor autocomplete.

Installation and Usage

pip install pythonista-stubs --upgrade

N.b. you may need to pip3, particularly if you installed python3 with homebrew

Type checking can then be performed with mypy

PyCharm: Works immediately
Vim: vim-mypy
Emacs: using Flycheck and Flycheck-mypy
Sublime Text: SublimeLinter-contrib-mypy
Atom: linter-mypy
VS Code: provides basic integration with mypy.
flake8: flake8-mypy

API Coverage

Module	Status
appex	✔
canvas	✘
cb	✘
clipboard	✔
console	✔
dialogs	✘
contacts	✘
editor	✘
keychain	✘
linguistictagger	✘
location	✘
motion	✘
notification	✘
objc_util	✘
photos	✘
reminders	✔
scene	✘
sound	✔
speech	✔
twitter	✘
ui	✘

Built With

PEPs

Contributing

Please file a bug report for any issues you find. Even more excellent than a good bug report is a fix for a bug, or the implementation of a much-needed stub. We'd love to have your contributions.

We use the usual GitHub pull-request flow, which may be familiar to you if you've contributed to other projects on GitHub. For the mechanics, see Mypy's git and GitHub workflow help page, or GitHub's own documentation.

Code Formatting

This project is linted with pyflakes and makes strict use of Black for code formatting.

Conventions

long functions and methods should be split up with one argument per line
all function bodies should be empty
prefer ... over pass
prefer ... on the same line as the class/function signature
avoid vertical whitespace between consecutive module-level functions, names, or methods and fields within a single class
use a single blank line between top-level class definitions
do not use docstrings
use variable annotations instead of type comments
for arguments with a type and a default, use spaces around the =
use float instead of Union[int, float]
avoid Union return types: https://github.com/python/mypy/issues/1693
imports in stubs are considered private unless they use the form from library import name as name
avoid using the Any type when possible
type variables and aliases for legibility reasons should be prefixed with an underscore to make it obvious to the reader they are not part of the stubbed API.
these conventions derived from typeshed

Code of Conduct

Everyone participating in this community is expected to treat other people with respect and more generally to follow the guidelines articulated in the Python Community Code of Conduct.

Authors

Harold Martin - harold.martin at gmail

Disclaimer

This is not an official project and is not associated with omz:software

License

Apache License 2.0

You might also like...

A simple password manager I typed with python using MongoDB .

Python with MongoDB A simple python code example using MongoDB. How do i run this code • First of all you need to have a python on your computer. If y

31 Dec 6, 2022

convert a dict-list object from / to a typed object(class instance with type annotation)

objtyping 带类型定义的对象转换器由来 Python不是强类型语言，开发人员没有给数据定义类型的习惯。这样虽然灵活，但处理复杂业务逻辑的时候却不够方便——缺乏类型检查可能导致很难发现错误，在IDE里编码时也没

15 Dec 22, 2022

A Simple, LightWeight, Statically-Typed Python3 API wrapper for GogoAnime.

AniKimi API A Simple, LightWeight, Statically-Typed Python3 API wrapper for GogoAnime The v2 of gogoanimeapi (depreciated) Made with JavaScript and Py

17 Dec 9, 2022

Statically typed BNF with semantic actions; A frontend of frontend frameworks; Use your grammar everywhere.

56 Dec 14, 2022

Run functions in parallel easily, with their results typed correctly!

typesafe_parmap pip install pip install typesafe-parmap Run functions in parallel safely with typesafe parmap! GitHub: https://github.com/thejaminato

3 Nov 6, 2021

Solutions to all 6 programming assignments in Dan Boneh's course Cryptography I, in statically typed Python.

Solutions to Cryptography I programming exercises Dan Boneh from Stanford University has an excellent online course on cryptography, hosted on Courser

8 Dec 16, 2022

cross-editor syntax highlighter for Lua, showing some merit of Typed BNF

Cross-editor contextual syntax highlighter via Typed BNF Do you like "one grammar, syntax highlighters everywhere?" 喜欢我一个文法，到处高亮吗？ PS: NOTE that paren

14 Feb 9, 2022

Pypixiv - A fully-typed, asynchronous api wrapper for pixiv

pypixiv this library is a fully-typed, asynchronous api wrapper for pixiv. featu

2 Nov 16, 2022

Collection of library stubs for Python, with static types

typeshed About Typeshed contains external type annotations for the Python standard library and Python builtins, as well as third party packages as con

3.3k Jan 2, 2023

PEP-484 stubs for Django

pep484 stubs for Django This package contains type stubs and a custom mypy plugin to provide more precise static types and type inference for Django f

1.1k Dec 30, 2022

PEP-484 stubs for django-rest-framework

pep484 stubs for Django REST framework Mypy stubs for DRF 3.12.x. Supports Python 3.6, 3.7, 3.8 and 3.9. Installation pip install djangorestframework-

303 Dec 27, 2022

open source tools to generate mypy stubs from protobufs

mypy-protobuf: Generate mypy stub files from protobuf specs We just released a new major release mypy-protobuf 2. on 02/02/2021! It includes some back

527 Jan 3, 2023

Mypy stubs, i.e., type information, for numpy, pandas and matplotlib

Mypy type stubs for NumPy, pandas, and Matplotlib This is a PEP-561-compliant stub-only package which provides type information for matplotlib, numpy

194 Dec 19, 2022

Re-apply type annotations from .pyi stubs to your codebase.

retype Re-apply type annotations from .pyi stubs to your codebase. Usage Usage: retype [OPTIONS] [SRC]... Re-apply type annotations from .pyi stubs

131 Nov 17, 2022

PEP-484 typing stubs for SQLAlchemy 1.4 and SQLAlchemy 2.0

SQLAlchemy 2 Stubs These are PEP-484 typing stubs for SQLAlchemy 1.4 and 2.0. They are released concurrently along with a Mypy extension which is desi

139 Dec 30, 2022

Stubmaker is an easy-to-use tool for generating python stubs.

Stubmaker is an easy-to-use tool for generating python stubs. Requirements Stubmaker is to be run under Python 3.7.4+ No side effects during

24 Aug 28, 2022

python package for generating typescript grpc-web stubs from protobuf files.

grpc-web-proto-compile NOTE: This package has been superseded by romnn/proto-compile, which provides the same functionality but offers a lot more flex

0 Sep 5, 2021

Pymxs, the 3DsMax bindings of Maxscript to Python doesn't come with any stubs

PyMXS Stubs generator What Pymxs, the 3DsMax bindings of Maxscript to Python doe

19 Dec 27, 2022

HMLLDB is a collection of LLDB commands to assist in the debugging of iOS apps.

HMLLDB is a collection of LLDB commands to assist in the debugging of iOS apps. 中文介绍 Features Non-intrusive. Your iOS project does not need to be modi

47 Oct 22, 2022

Comments

Stubs for the `sound` module

Stubs for the sound module. I wasn't sure about a set of types based on the documentation (whether they would be defined as float or int) so I reversed them to be sure. Code is added below, for the sake of completeness for the documentation.

>>> def test_recording():
...   rec = sound.Recorder('test.m4a')
...   rec.record()
...   time.sleep(2)
...   print(rec.current_time, type(rec.current_time))
...   print(rec.recording)
...   time.sleep(3)
...   rec.stop()
...   
>>> test_recording()
2.0232426303854876 <class 'float'>
True
>>> def test_playback():
...   play = sound.Player('test.m4a')
...   play.play()
...   time.sleep(2)
...   print(play.duration, type(play.duration))
...   print(play.current_time, type(play.current_time))
...   
>>> test_playback()
5.037278911564626 <class 'float'>
1.9657596371882087 <class 'float'>

Although there are no merge conflicts with master, when/if #1 gets merged, there will be a conflict with setup.py. I put it as draft PR to prevent the merge conflict there, and will change that after a merge of #1.

opened by boisei0 3

Added stubs for `speech`

I've created stubs for the speech module. As mentioned in the commit comment, the top level get_languages function is a bit of a guess whether or not it should be publicly exposed and supported with typings.

opened by boisei0 3

Typed interface stubs for Pythonista iOS

Related tags

Overview

Pythonista Stubs

Installation and Usage

API Coverage

Built With

PEPs

Contributing

Code Formatting

Conventions

Code of Conduct

Authors

Disclaimer

License

You might also like...

A simple password manager I typed with python using MongoDB .

convert a dict-list object from / to a typed object(class instance with type annotation)

A Simple, LightWeight, Statically-Typed Python3 API wrapper for GogoAnime.

Statically typed BNF with semantic actions; A frontend of frontend frameworks; Use your grammar everywhere.

Run functions in parallel easily, with their results typed correctly!

Solutions to all 6 programming assignments in Dan Boneh's course Cryptography I, in statically typed Python.

cross-editor syntax highlighter for Lua, showing some merit of Typed BNF

Pypixiv - A fully-typed, asynchronous api wrapper for pixiv

Collection of library stubs for Python, with static types

PEP-484 stubs for Django

PEP-484 stubs for django-rest-framework

open source tools to generate mypy stubs from protobufs

Mypy stubs, i.e., type information, for numpy, pandas and matplotlib

Re-apply type annotations from .pyi stubs to your codebase.

PEP-484 typing stubs for SQLAlchemy 1.4 and SQLAlchemy 2.0

Stubmaker is an easy-to-use tool for generating python stubs.

python package for generating typescript grpc-web stubs from protobuf files.

Pymxs, the 3DsMax bindings of Maxscript to Python doesn't come with any stubs

HMLLDB is a collection of LLDB commands to assist in the debugging of iOS apps.

Comments

Stubs for the `sound` module

Added stubs for `speech`

Releases(v0.0.2)

v0.0.2(Mar 22, 2019)

Owner

Harold Martin

Rust like Option and Result types in Python

A plugin for Flake8 that provides specializations for type hinting stub files

Design by contract for Python. Write bug-free code. Add a few decorators, get static analysis and tests for free.

It's not just a linter that annoys you!

A static type analyzer for Python code

coala provides a unified command-line interface for linting and fixing all your code, regardless of the programming languages you use.

:sparkles: Surface lint errors during code review

Flake8 plugin for managing type-checking imports & forward references

Flake8 wrapper to make it nice, legacy-friendly, configurable.

A plugin for Flake8 finding likely bugs and design problems in your program. Contains warnings that don't belong in pyflakes and pycodestyle.

Pyright extension for coc.nvim

A plugin for Flake8 that checks pandas code

Flake8 plugin for managing type-checking imports & forward references

Flashcards - A flash card application with 2 optional command line arguments

👻 Phantom types for Python

Plugin for mypy to support zope.interface

Run isort, pyupgrade, mypy, pylint, flake8, and more on Jupyter Notebooks

Utilities for pycharm code formatting (flake8 and black)

A plugin for flake8 integrating Mypy.

A python documentation linter which checks that the docstring description matches the definition.