Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: make get_solc_version() method public #153

Merged
merged 3 commits into from
Nov 7, 2023
Merged

feat: make get_solc_version() method public #153

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
287c1a5
feat: make method not internal
antazoey Aug 25, 2022
e7a76c3
feat: make method not internal
antazoey Aug 25, 2022
9ba3755
feat: make method not internal
antazoey Aug 25, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions solcx/install.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ def import_installed_solc(solcx_binary_path: Union[Path, str] = None) -> List[Ve
imported_versions = []
for path in path_list:
try:
version = wrapper._get_solc_version(path)
version = wrapper.get_solc_version(path)
assert version not in get_installed_solc_versions()
except Exception:
continue
Expand All @@ -151,7 +151,7 @@ def import_installed_solc(solcx_binary_path: Union[Path, str] = None) -> List[Ve
shutil.copy(path, copy_path)
try:
# confirm that solc still works after being copied
assert version == wrapper._get_solc_version(copy_path)
assert version == wrapper.get_solc_version(copy_path)
imported_versions.append(version)
except Exception:
_unlink_solc(copy_path)
Expand Down Expand Up @@ -630,7 +630,7 @@ def _install_solc_windows(
def _validate_installation(version: Version, solcx_binary_path: Union[Path, str, None]) -> None:
binary_path = get_executable(version, solcx_binary_path)
try:
installed_version = wrapper._get_solc_version(binary_path)
installed_version = wrapper.get_solc_version(binary_path)
except Exception:
_unlink_solc(binary_path)
raise SolcInstallationError(
Expand Down
2 changes: 1 addition & 1 deletion solcx/main.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ def get_solc_version(with_commit_hash: bool = False) -> Version:
solc version
"""
solc_binary = get_executable()
return wrapper._get_solc_version(solc_binary, with_commit_hash)
return wrapper.get_solc_version(solc_binary, with_commit_hash)


def compile_source(
Expand Down
8 changes: 6 additions & 2 deletions solcx/wrapper.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,11 @@


def _get_solc_version(solc_binary: Union[Path, str], with_commit_hash: bool = False) -> Version:
# private wrapper function to get `solc` version
# TODO: Remove around 1.2.0. Was private, kept to prevent accidentally breaking downstream.
return get_solc_version(solc_binary, with_commit_hash=with_commit_hash)


def get_solc_version(solc_binary: Union[Path, str], with_commit_hash: bool = False) -> Version:
stdout_data = subprocess.check_output([str(solc_binary), "--version"], encoding="utf8")
try:
match = next(re.finditer(VERSION_REGEX, stdout_data))
Expand Down Expand Up @@ -95,7 +99,7 @@ def solc_wrapper(
else:
solc_binary = install.get_executable()

solc_version = _get_solc_version(solc_binary)
solc_version = get_solc_version(solc_binary)
command: List = [str(solc_binary)]

if success_return_code is None:
Expand Down
4 changes: 2 additions & 2 deletions tests/install/test_compile.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ def test_compile_already_installed():

@pytest.mark.skipif("sys.platform == 'win32'")
def test_compile(compile_mock, solc_binary, cwd):
version = solcx.wrapper._get_solc_version(solc_binary)
version = solcx.wrapper.get_solc_version(solc_binary)
solcx.compile_solc(version)

assert os.getcwd() == cwd
Expand All @@ -31,7 +31,7 @@ def test_compile(compile_mock, solc_binary, cwd):

@pytest.mark.skipif("sys.platform == 'win32'")
def test_compile_install_deps_fails(compile_mock, solc_binary, cwd):
version = solcx.wrapper._get_solc_version(solc_binary)
version = solcx.wrapper.get_solc_version(solc_binary)
compile_mock.raise_on("sh")
solcx.compile_solc(version)

Expand Down
6 changes: 3 additions & 3 deletions tests/install/test_import_solc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@


def test_import_solc(monkeypatch, solc_binary, nosolc):
version = solcx.wrapper._get_solc_version(solc_binary)
version = solcx.wrapper.get_solc_version(solc_binary)

monkeypatch.setattr("solcx.install._get_which_solc", lambda: solc_binary)
assert solcx.import_installed_solc() == [version]
Expand All @@ -14,7 +14,7 @@ def test_import_solc(monkeypatch, solc_binary, nosolc):

def test_import_solc_fails_after_importing(monkeypatch, solc_binary, nosolc):
count = 0
version = solcx.wrapper._get_solc_version(solc_binary)
version = solcx.wrapper.get_solc_version(solc_binary)

def version_mock(*args):
# the first version call succeeds, the second attempt fails
Expand All @@ -26,7 +26,7 @@ def version_mock(*args):
raise Exception

monkeypatch.setattr("solcx.install._get_which_solc", lambda: solc_binary)
monkeypatch.setattr("solcx.wrapper._get_solc_version", version_mock)
monkeypatch.setattr("solcx.wrapper.get_solc_version", version_mock)

assert solcx.import_installed_solc() == []
assert not nosolc.joinpath(solc_binary.name).exists()
6 changes: 3 additions & 3 deletions tests/install/test_validate_installation.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@


def test_validate_installation_wrong_version(monkeypatch, install_mock, install_path):
monkeypatch.setattr("solcx.wrapper._get_solc_version", lambda k: Version("0.0.0"))
monkeypatch.setattr("solcx.wrapper.get_solc_version", lambda k: Version("0.0.0"))

with pytest.raises(UnexpectedVersionError):
solcx.install_solc()
Expand All @@ -19,8 +19,8 @@ def test_validate_installation_wrong_version(monkeypatch, install_mock, install_


def test_validate_installation_nightly(monkeypatch, install_mock, solc_binary, install_path):
version = solcx.wrapper._get_solc_version(solc_binary)
monkeypatch.setattr("solcx.wrapper._get_solc_version", lambda k: Version(f"{version}-nightly"))
version = solcx.wrapper.get_solc_version(solc_binary)
monkeypatch.setattr("solcx.wrapper.get_solc_version", lambda k: Version(f"{version}-nightly"))

with pytest.warns(UnexpectedVersionWarning):
solcx.install_solc()
Expand Down