TST: Create is_ci_environment helper (#45812)

Author: mroeschke

pandas/compat/__init__.py

@@ -7,6 +7,7 @@
 Other items:
 * platform checker
 """
+import os
 import platform
 import sys
 
@@ -89,7 +90,7 @@ def is_platform_mac() -> bool:
 
 def is_platform_arm() -> bool:
     """
-    Checking if he running platform use ARM architecture.
+    Checking if the running platform use ARM architecture.
 
     Returns
     -------
@@ -101,6 +102,19 @@ def is_platform_arm() -> bool:
     )
 
 
+def is_ci_environment() -> bool:
+    """
+    Checking if running in a continuous integration environment by checking
+    the PANDAS_CI environment variable.
+
+    Returns
+    -------
+    bool
+        True if the running in a continuous integration environment.
+    """
+    return os.environ.get("PANDAS_CI", "0") == "1"
+
+
 def get_lzma_file():
     """
     Importing the `LZMAFile` class from the `lzma` module.

pandas/tests/io/conftest.py

@@ -6,6 +6,7 @@
 import pytest
 
 from pandas.compat import (
+    is_ci_environment,
     is_platform_arm,
     is_platform_mac,
     is_platform_windows,
@@ -42,7 +43,7 @@ def feather_file(datapath):
 
 @pytest.fixture
 def s3so(worker_id):
-    if os.environ.get("PANDAS_CI", "0") == "1":
+    if is_ci_environment():
         url = "http://localhost:5000/"
     else:
         worker_id = "5" if worker_id == "master" else worker_id.lstrip("gw")
@@ -66,7 +67,7 @@ def s3_base(worker_id):
         # see https://github.com/spulec/moto/issues/1924 & 1952
         os.environ.setdefault("AWS_ACCESS_KEY_ID", "foobar_key")
         os.environ.setdefault("AWS_SECRET_ACCESS_KEY", "foobar_secret")
-        if os.environ.get("PANDAS_CI", "0") == "1":
+        if is_ci_environment():
             if is_platform_arm() or is_platform_mac() or is_platform_windows():
                 # NOT RUN on Windows/MacOS/ARM, only Ubuntu
                 # - subprocess in CI can cause timeouts

pandas/tests/io/parser/test_network.py

@@ -7,11 +7,11 @@
     StringIO,
 )
 import logging
-import os
 
 import numpy as np
 import pytest
 
+from pandas.compat import is_ci_environment
 import pandas.util._test_decorators as td
 
 from pandas import DataFrame
@@ -263,7 +263,7 @@ def test_read_csv_handles_boto_s3_object(self, s3_resource, tips_file):
         tm.assert_frame_equal(result, expected)
 
     @pytest.mark.skipif(
-        os.environ.get("PANDAS_CI", "0") == "1",
+        is_ci_environment(),
         reason="This test can hang in our CI min_versions build "
         "and leads to '##[error]The runner has "
         "received a shutdown signal...' in GHA. GH: 45651",

pandas/tests/io/test_user_agent.py

@@ -5,20 +5,20 @@
 import http.server
 from io import BytesIO
 import multiprocessing
-import os
 import socket
 import time
 import urllib.error
 
 import pytest
 
+from pandas.compat import is_ci_environment
 import pandas.util._test_decorators as td
 
 import pandas as pd
 import pandas._testing as tm
 
 pytestmark = pytest.mark.skipif(
-    os.environ.get("PANDAS_CI", "0") == "1",
+    is_ci_environment(),
     reason="This test can hang in our CI min_versions build "
     "and leads to '##[error]The runner has "
     "received a shutdown signal...' in GHA. GH 45651",

pandas/tests/io/xml/test_xml.py

@@ -12,6 +12,7 @@
 import numpy as np
 import pytest
 
+from pandas.compat import is_ci_environment
 from pandas.compat._optional import import_optional_dependency
 import pandas.util._test_decorators as td
 
@@ -1107,7 +1108,7 @@ def test_unsuported_compression(parser):
 @td.skip_if_no("s3fs")
 @td.skip_if_no("lxml")
 @pytest.mark.skipif(
-    os.environ.get("PANDAS_CI", "0") == "1",
+    is_ci_environment(),
     reason="2022.1.17: Hanging on the CI min versions build.",
 )
 @tm.network

pandas/tests/test_sorting.py

@@ -1,12 +1,14 @@
 from collections import defaultdict
 from datetime import datetime
 from itertools import product
-import os
 
 import numpy as np
 import pytest
 
-from pandas.compat import is_platform_windows
+from pandas.compat import (
+    is_ci_environment,
+    is_platform_windows,
+)
 
 from pandas import (
     DataFrame,
@@ -428,7 +430,7 @@ def test_codes(self, verify, codes, exp_codes, na_sentinel):
         tm.assert_numpy_array_equal(result_codes, expected_codes)
 
     @pytest.mark.skipif(
-        is_platform_windows() and os.environ.get("PANDAS_CI", "0") == "1",
+        is_platform_windows() and is_ci_environment(),
         reason="In CI environment can crash thread with: "
         "Windows fatal exception: access violation",
     )

pandas/tests/window/test_numba.py

@@ -1,9 +1,8 @@
-import os
-
 import numpy as np
 import pytest
 
 from pandas.compat import (
+    is_ci_environment,
     is_platform_mac,
     is_platform_windows,
 )
@@ -21,8 +20,7 @@
 
 # TODO(GH#44584): Mark these as pytest.mark.single
 pytestmark = pytest.mark.skipif(
-    os.environ.get("PANDAS_CI", "0") == "1"
-    and (is_platform_windows() or is_platform_mac()),
+    is_ci_environment() and (is_platform_windows() or is_platform_mac()),
     reason="On Azure CI, Windows can fail with "
     "'Windows fatal exception: stack overflow' "
     "and MacOS can timeout",

pandas/tests/window/test_online.py

@@ -1,9 +1,8 @@
-import os
-
 import numpy as np
 import pytest
 
 from pandas.compat import (
+    is_ci_environment,
     is_platform_mac,
     is_platform_windows,
 )
@@ -17,8 +16,7 @@
 
 # TODO(GH#44584): Mark these as pytest.mark.single
 pytestmark = pytest.mark.skipif(
-    os.environ.get("PANDAS_CI", "0") == "1"
-    and (is_platform_windows() or is_platform_mac()),
+    is_ci_environment() and (is_platform_windows() or is_platform_mac()),
     reason="On Azure CI, Windows can fail with "
     "'Windows fatal exception: stack overflow' "
     "and MacOS can timeout",