This repository has been archived by the owner on Dec 1, 2023. It is now read-only.
Move utils.py from Contracts to Nile #163
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
martriay
approved these changes
Aug 11, 2022
utils.py
Outdated
| @@ -0,0 +1,195 @@ | |||
| """Utilities for Cairo contracts.""" | |||
There was a problem hiding this comment.
Suggested change
| """Utilities for Cairo contracts.""" | |
| """Utilities for Nile scripting.""" |
utils.py
Outdated
|
|
||
|
|
||
| def felt_to_str(felt): | ||
| """Return a string from a given field element.""" |
There was a problem hiding this comment.
Suggested change
| """Return a string from a given field element.""" | |
| """Return a string from a given field element.""" | |
| felt = int(felt, 16) if "0x" in felt else felt |
this added line provides hexadecimal support (something users have been asking for). I know this breaks the "cleanliness" of the code migration but I think it adds a lot of value.
martriay
suggested changes
Aug 11, 2022
martriay
reviewed
Aug 11, 2022
utils.py
Outdated
Comment on lines
119
to
140
| def _get_path_from_name(name): | ||
| """Return the contract path by contract name.""" | ||
| dirs = ["src", "tests/mocks"] | ||
| for dir in dirs: | ||
| for (dirpath, _, filenames) in os.walk(dir): | ||
| for file in filenames: | ||
| if file == f"{name}.cairo": | ||
| return os.path.join(dirpath, file) | ||
|
|
||
| raise FileNotFoundError(f"Cannot find '{name}'.") | ||
|
|
||
|
|
||
| def get_contract_class(contract, is_path=False): | ||
| """Return the contract class from the contract name or path.""" | ||
| if is_path: | ||
| path = contract_path(contract) | ||
| else: | ||
| path = _get_path_from_name(contract) | ||
|
|
||
| contract_class = compile_starknet_files(files=[path], debug_info=True) | ||
| return contract_class | ||
|
|
There was a problem hiding this comment.
Traceback (most recent call last):
File "/home/workshop/env/bin/nile", line 5, in <module>
from nile.cli import cli
File "/home/workshop/env/lib/python3.8/site-packages/nile/cli.py", line 20, in <module>
from nile.utils.debug import debug as debug_command
File "/home/workshop/env/lib/python3.8/site-packages/nile/utils/__init__.py", line 169, in <module>
class Account:
File "/home/workshop/env/lib/python3.8/site-packages/nile/utils/__init__.py", line 181, in Account
get_class = get_contract_class("Account")
File "/home/workshop/env/lib/python3.8/site-packages/nile/utils/__init__.py", line 136, in get_contract_class
path = _get_path_from_name(contract)
File "/home/workshop/env/lib/python3.8/site-packages/nile/utils/__init__.py", line 128, in _get_path_from_name
raise FileNotFoundError(f"Cannot find '{name}'.")
FileNotFoundError: Cannot find 'Account'.
I think some of these functions weren't easily portable since they depend on structure and contents from Contracts. We might be better off leaving them out of this beta.
Tunnel vision on my part for ease of use^. Where do you think is most appropriate? |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR moves the
utils.pyfrom Contracts for Cairo to Nile in order to allow users to easily import the utility functions. This PR proposes to includeutils.pyin Nile's root thus:from nile.utils import *.