Skip to content

Commit

Permalink
prefer sys.platform over os.name when checking for windows OS
Browse files Browse the repository at this point in the history
  • Loading branch information
m-rsha committed Mar 4, 2023
1 parent 2822de9 commit 5ce4a54
Show file tree
Hide file tree
Showing 8 changed files with 13 additions and 10 deletions.
3 changes: 2 additions & 1 deletion pre_commit/languages/conda.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

import contextlib
import os
import sys
from typing import Generator
from typing import Sequence

Expand All @@ -26,7 +27,7 @@ def get_env_patch(env: str) -> PatchesT:
# $CONDA_PREFIX/Scripts and $CONDA_PREFIX. Whereas the latter only
# seems to be used for python.exe.
path: SubstitutionT = (os.path.join(env, 'bin'), os.pathsep, Var('PATH'))
if os.name == 'nt': # pragma: no cover (platform specific)
if sys.platform == 'win32': # pragma: win32 cover
path = (env, os.pathsep, *path)
path = (os.path.join(env, 'Scripts'), os.pathsep, *path)
path = (os.path.join(env, 'Library', 'bin'), os.pathsep, *path)
Expand Down
4 changes: 2 additions & 2 deletions pre_commit/languages/python.py
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ def _read_pyvenv_cfg(filename: str) -> dict[str, str]:

def bin_dir(venv: str) -> str:
"""On windows there's a different directory for the virtualenv"""
bin_part = 'Scripts' if os.name == 'nt' else 'bin'
bin_part = 'Scripts' if sys.platform == 'win32' else 'bin'
return os.path.join(venv, bin_part)


Expand Down Expand Up @@ -137,7 +137,7 @@ def norm_version(version: str) -> str | None:
elif _sys_executable_matches(version): # virtualenv defaults to our exe
return None

if os.name == 'nt': # pragma: no cover (windows)
if sys.platform == 'win32': # pragma: no cover (windows)
version_exec = _find_by_py_launcher(version)
if version_exec:
return version_exec
Expand Down
2 changes: 1 addition & 1 deletion pre_commit/util.py
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ def cmd_output(*cmd: str, **kwargs: Any) -> tuple[int, str, str | None]:
return returncode, stdout, stderr


if os.name != 'nt': # pragma: win32 no cover
if sys.platform != 'win32': # pragma: win32 no cover
from os import openpty
import termios

Expand Down
3 changes: 2 additions & 1 deletion testing/util.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
import contextlib
import os.path
import subprocess
import sys

import pytest

Expand Down Expand Up @@ -30,7 +31,7 @@ def cmd_output_mocked_pre_commit_home(
return ret, out.replace('\r\n', '\n'), None


xfailif_windows = pytest.mark.xfail(os.name == 'nt', reason='windows')
xfailif_windows = pytest.mark.xfail(sys.platform == 'win32', reason='windows')


def run_opts(
Expand Down
4 changes: 2 additions & 2 deletions tests/languages/python_test.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,10 @@ def test_read_pyvenv_cfg_non_utf8(tmpdir):

def test_norm_version_expanduser():
home = os.path.expanduser('~')
if os.name == 'nt': # pragma: nt cover
if sys.platform == 'win32': # pragma: win32 cover
path = r'~\python343'
expected_path = fr'{home}\python343'
else: # pragma: nt no cover
else: # pragma: win32 no cover
path = '~/.pyenv/versions/3.4.3/bin/python'
expected_path = f'{home}/.pyenv/versions/3.4.3/bin/python'
result = python.norm_version(path)
Expand Down
2 changes: 1 addition & 1 deletion tests/parse_shebang_test.py
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ def test_normexe_does_not_exist_sep():
assert excinfo.value.args == ('Executable `./i-dont-exist-lol` not found',)


@pytest.mark.xfail(os.name == 'nt', reason='posix only')
@pytest.mark.xfail(sys.platform == 'win32', reason='posix only')
def test_normexe_not_executable(tmpdir): # pragma: win32 no cover
tmpdir.join('exe').ensure()
with tmpdir.as_cwd(), pytest.raises(OSError) as excinfo:
Expand Down
3 changes: 2 additions & 1 deletion tests/repository_test.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

import os.path
import shutil
import sys
from typing import Any
from unittest import mock

Expand Down Expand Up @@ -198,7 +199,7 @@ def test_intermixed_stdout_stderr(tempdir_factory, store):
)


@pytest.mark.xfail(os.name == 'nt', reason='ptys are posix-only')
@pytest.mark.xfail(sys.platform == 'win32', reason='ptys are posix-only')
def test_output_isatty(tempdir_factory, store):
_test_hook_repo(
tempdir_factory, store, 'stdout_stderr_repo',
Expand Down
2 changes: 1 addition & 1 deletion tests/xargs_test.py
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ def test_xargs_propagate_kwargs_to_cmd():
assert b'Pre commit is awesome' in stdout


@pytest.mark.xfail(os.name == 'nt', reason='posix only')
@pytest.mark.xfail(sys.platform == 'win32', reason='posix only')
def test_xargs_color_true_makes_tty():
retcode, out = xargs.xargs(
(sys.executable, '-c', 'import sys; print(sys.stdout.isatty())'),
Expand Down

0 comments on commit 5ce4a54

Please sign in to comment.