CodeHint 0.0.1
CodeHint is a package for describing a function within the python console during runtime. It works in the same way as an advanced IDE does when it displays the hint for function, but pretty-printing to console rather than to a window.
Example
If we have the following function defined somewhere in our code:
>>> def hello(a, b:int, c) -> int:
... """
... Hello, this is an explanation
... of what this is going to do
... :param a: foo
... :param b: bar example
... :param c:
... :return: True if good, False otherwise.
... """
... x = a + b * 2*c
... return x
It can be described later on with CodeHint:
>>> from codehint import hint
>>> hint(hello)
The result is
------------------------
def hello(a, b:int, c) -> int:
Hello, this is an explanation of what this is going to do
=== Parameters: 3 ======
[0] a (type Any) -> foo
[1] b (type int) -> bar example
[2] c (type Any) ->
========================
Result (type int) -> True if good, False otherwise.
CodeHint currently can only be used to describe the signature of functions or methods.
Installation
It is only supported Python 3.4.1 onwards:
sudo pip3 install codehint
LICENSE
It is released under the MIT license.
Metadata
Release files for codehint 0.0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| codehint-0.0.1.tar.gz | 5.3 kB | Without provenance | Details for codehint-0.0.1.tar.gz |
Release files / codehint-0.0.1.tar.gz
| Download URL | codehint-0.0.1.tar.gz |
|---|---|
| Size | 5.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
cb5dc624b5722f1f5333f6d87d14f70a4f9259624539f1ec7b615b15d9a8beee
|
|
BLAKE2b-256 checksum How to use checksums |
0ce97024c2f3a3f409b3e4d59509d673468f48eb6423e2e42fb4aa1a95bc4ee6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for codehint 0.0.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.