Specialized types for callable objects in Python.
Table of Contents
Python 3.x provides customized callable types.
How can we distinguish between types like class, function, and method? You might think of using the types or inspect modules as a solution. However, these traditional types can be a bit confusing. Especially when it comes to distinguishing between function and method types, you'll notice that types.FunctionType does not cover types.MethodType. For this reason, callable types have been redefined using this library.
To get a local copy up and running follow these simple example steps.
Does not require any prerequisites
- Clone the repo
git clone https://github.com/TahsinCr/python-callabletype.git- Install PIP packages
pip install callabletypeWe have a class named Parrot(name, color, age) that includes a method walk(self). Additionally, there is a function called parrot_fly(). We can choose and control the types of these functions in detail.
from callabletype import (
get_callable_type, is_function, CLASS, FUNCTION, METHOD, SELFMETHOD, INSTANCESELFMETHOD
)
class Parrot:
def __init__(self, name:str, color:str, age:int):
self.name = name
self.color = color
self.age = age
def walk(self):
print("The parrot named {} walked".format(self.name))
def parrot_fly(parrot:Parrot):
print("The parrot named {} flew".format(parrot.name))
parrot = Parrot(name='Kiwi', color='green', age=14)
objects = {
'function' : parrot_fly,
'class' : Parrot,
'method' : Parrot.walk,
'self-method' : Parrot.walk,
'instance-self-method' : parrot.walk
}
for type_name, object in objects.items():
type = get_callable_type(object)
check_function = is_function(object)
check_method = type in METHOD
check_class = CLASS.check_func(object)
print("'{}' : {} (result_type={}, is_function={}, is_method={}, is_class={})\n".format(
object, type_name, type, check_function, check_method, check_class
))Output
'<function parrot_fly at 0x000001D8C23F3EC0>' : function (result_type=FUNCTION, is_function=True, is_method=False, is_class=False)
'<class '__main__.Parrot'>' : class (result_type=CLASS, is_function=False, is_method=False, is_class=True)
'<function Parrot.walk at 0x000001D8C25B1260>' : method (result_type=SELFMETHOD, is_function=True, is_method=True, is_class=False)
'<function Parrot.walk at 0x000001D8C25B1260>' : self-method (result_type=SELFMETHOD, is_function=True, is_method=True, is_class=False)
'<bound method Parrot.walk of <__main__.Parrot object at 0x000001D8C2455BE0>>' : instance-self-method (result_type=INSTANCESELFMETHOD, is_function=True, is_method=True, is_class=False)
For more examples, please refer to the Documentation
- Add documentation.
See the open issues for a full list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
-
Fork the Project
-
Create your Feature Branch (
git checkout -b feature/AmazingFeature) -
Commit your Changes (
git commit -m 'Add some AmazingFeature') -
Push to the Branch (
git push origin feature/AmazingFeature) -
Open a Pull Request
Distributed under the MIT License. See LICENSE for more information.
Email: TahsinCr@outlook.com
X: @TahsinCrs
LinkedIn: TahsinCr
-
[C-Sharp Linq Documents][dotnet-lib-linq]