https://github.com/ashercn97/interface2.py

A python implementation of Typescript interfaces!
https://github.com/ashercn97/interface2.py

Last synced: 12 days ago
JSON representation

A python implementation of Typescript interfaces!

• Host: GitHub
• URL: https://github.com/ashercn97/interface2.py
• Owner: ashercn97
• Created: 2023-09-04T20:45:54.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-09-07T23:10:46.000Z (about 1 year ago)
• Last Synced: 2023-09-07T23:59:10.265Z (about 1 year ago)
• Language: Python
• Homepage:
• Size: 32.2 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Interface2.py

A very starting implementation of typescript interfaces in python! I was not satisfied with the dataclasses in python, so I attempted to make something similar to typescript interfaces !! My original plan was to do something like typechat in python, but I realized I needed something better than dataclasses.

The decorators are used to add more functionality to the code. The two current ones are one to make the interface immutable and the other to make it able to take multiple types as a type. I am expecting a TON of bugs, so please lmk if there are any!

To use it, you can clone the repo and then import the IF4 (the main file).

UPDATE:

you can now install it using pip!!

for example:

```

python -m pip install Interface2py

```

for info on how to use it, view the example ipynb

Then, you could do the following:

```

@multiple

class MyInterface(IF4.Interface):

    _properties = {

        "name": str,

        "age": (int, float)

    }

```

You could wrap them with the decorators too! IF you have ANY questions, please leave an issue and ill be happy to get back to you.

This is one of my first public projects! If anyone has any suggestions for changes/improvements/anything please let me know!!

please see the examples folder for examples of how to use it