From 28fdb9d2bc6a3c4fcc18fefe7ae373013ab8e9c9 Mon Sep 17 00:00:00 2001
From: Andong Zhan <andong.zhan@snowflake.com>
Date: Wed, 5 Jun 2024 10:09:46 -0700
Subject: [PATCH] CI: ignore some not implemented methods code coverage (#1736)

---
 .../snowpark/modin/plugin/docstrings/base.py  |  2 +-
 .../modin/plugin/docstrings/dataframe.py      |  2 +-
 .../modin/plugin/docstrings/groupby.py        |  4 +--
 .../modin/plugin/docstrings/resample.py       |  4 +--
 .../modin/plugin/docstrings/series.py         |  2 +-
 .../snowpark/modin/plugin/io/snow_io.py       | 30 +++++++++----------
 tox.ini                                       |  6 ++--
 7 files changed, 26 insertions(+), 24 deletions(-)

diff --git a/src/snowflake/snowpark/modin/plugin/docstrings/base.py b/src/snowflake/snowpark/modin/plugin/docstrings/base.py
index 1dbd11221bc..63c27e864a5 100644
--- a/src/snowflake/snowpark/modin/plugin/docstrings/base.py
+++ b/src/snowflake/snowpark/modin/plugin/docstrings/base.py
@@ -385,7 +385,7 @@
 """
 
 
-class BasePandasDataset:  # pragma: no cover: we use this class's docstrings, but we never execute its methods.
+class BasePandasDataset:
     """
     Implement most of the common code that exists in DataFrame/Series.
 
diff --git a/src/snowflake/snowpark/modin/plugin/docstrings/dataframe.py b/src/snowflake/snowpark/modin/plugin/docstrings/dataframe.py
index 22d68216671..0ae41202922 100644
--- a/src/snowflake/snowpark/modin/plugin/docstrings/dataframe.py
+++ b/src/snowflake/snowpark/modin/plugin/docstrings/dataframe.py
@@ -45,7 +45,7 @@
 }
 
 
-class DataFrame:  # pragma: no cover: we use this class's docstrings, but we never execute its methods.
+class DataFrame:
     """
     Snowpark pandas representation of ``pandas.DataFrame`` with a lazily-evaluated relational dataset.
 
diff --git a/src/snowflake/snowpark/modin/plugin/docstrings/groupby.py b/src/snowflake/snowpark/modin/plugin/docstrings/groupby.py
index 592fae48183..8c899615d82 100644
--- a/src/snowflake/snowpark/modin/plugin/docstrings/groupby.py
+++ b/src/snowflake/snowpark/modin/plugin/docstrings/groupby.py
@@ -174,7 +174,7 @@
 )
 
 
-class DataFrameGroupBy:  # pragma: no cover: we use this class's docstrings, but we never execute its methods.
+class DataFrameGroupBy:
     def __getattr__():
         """
         Alter regular attribute access, looks up the name in the columns.
@@ -1872,7 +1872,7 @@ def pipe():
         pass
 
 
-class SeriesGroupBy:  # pragma: no cover: we use this class's docstrings, but we never execute its methods.
+class SeriesGroupBy:
     @property
     def ndim(self):
         """
diff --git a/src/snowflake/snowpark/modin/plugin/docstrings/resample.py b/src/snowflake/snowpark/modin/plugin/docstrings/resample.py
index 0b94b22c3f1..1d3439a36b6 100644
--- a/src/snowflake/snowpark/modin/plugin/docstrings/resample.py
+++ b/src/snowflake/snowpark/modin/plugin/docstrings/resample.py
@@ -7,8 +7,8 @@
 from textwrap import dedent
 
 
-class Resampler:  # pragma: no cover: we use this class's docstrings, but we never execute its methods.
-    def __getitem__(self, key):  # pragma: no cover
+class Resampler:
+    def __getitem__(self, key):
         """
         Get ``Resampler`` based on `key` columns of original dataframe.
 
diff --git a/src/snowflake/snowpark/modin/plugin/docstrings/series.py b/src/snowflake/snowpark/modin/plugin/docstrings/series.py
index 735fa2ad535..1b842942cd7 100644
--- a/src/snowflake/snowpark/modin/plugin/docstrings/series.py
+++ b/src/snowflake/snowpark/modin/plugin/docstrings/series.py
@@ -33,7 +33,7 @@
 }
 
 
-class Series:  # pragma: no cover: we use this class's docstrings, but we never execute its methods.
+class Series:
     """
     Snowpark pandas representation of `pandas.Series` with a lazily-evaluated relational dataset.
 
diff --git a/src/snowflake/snowpark/modin/plugin/io/snow_io.py b/src/snowflake/snowpark/modin/plugin/io/snow_io.py
index 5d7f6754101..8976aeafcab 100644
--- a/src/snowflake/snowpark/modin/plugin/io/snow_io.py
+++ b/src/snowflake/snowpark/modin/plugin/io/snow_io.py
@@ -564,7 +564,7 @@ def read_gbq(
         progress_bar_type=None,
         max_results=None,
     ):
-        pass
+        pass  # pragma: no cover
 
     @classmethod
     @pandas_module_level_function_not_implemented()
@@ -588,17 +588,17 @@ def read_html(
         displayed_only=True,
         **kwargs,
     ):
-        pass
+        pass  # pragma: no cover
 
     @classmethod
     @pandas_module_level_function_not_implemented()
     def read_clipboard(cls, sep=r"\s+", **kwargs):
-        pass
+        pass  # pragma: no cover
 
     @classmethod
     @pandas_module_level_function_not_implemented()
     def read_excel(cls, **kwargs):
-        pass
+        pass  # pragma: no cover
 
     @classmethod
     @pandas_module_level_function_not_implemented()
@@ -616,7 +616,7 @@ def read_hdf(
         chunksize=None,
         **kwargs,
     ):
-        pass
+        pass  # pragma: no cover
 
     @classmethod
     @pandas_module_level_function_not_implemented()
@@ -625,7 +625,7 @@ def read_feather(
         path,
         **kwargs,
     ):
-        pass
+        pass  # pragma: no cover
 
     @classmethod
     @pandas_module_level_function_not_implemented()
@@ -634,7 +634,7 @@ def read_stata(
         filepath_or_buffer,
         **kwargs,
     ):
-        pass
+        pass  # pragma: no cover
 
     @classmethod
     @pandas_module_level_function_not_implemented()
@@ -649,7 +649,7 @@ def read_sas(
         iterator=False,
         **kwargs,
     ):
-        pass
+        pass  # pragma: no cover
 
     @classmethod
     @pandas_module_level_function_not_implemented()
@@ -658,7 +658,7 @@ def read_pickle(
         filepath_or_buffer,
         **kwargs,
     ):
-        pass
+        pass  # pragma: no cover
 
     @classmethod
     @pandas_module_level_function_not_implemented()
@@ -675,7 +675,7 @@ def read_sql(
         dtype_backend=no_default,
         dtype=None,
     ):
-        pass
+        pass  # pragma: no cover
 
     @classmethod
     @pandas_module_level_function_not_implemented()
@@ -691,7 +691,7 @@ def read_fwf(
         chunksize=None,
         **kwds,
     ):
-        pass
+        pass  # pragma: no cover
 
     @classmethod
     @pandas_module_level_function_not_implemented()
@@ -707,7 +707,7 @@ def read_sql_table(
         chunksize=None,
         dtype_backend=no_default,
     ):
-        pass
+        pass  # pragma: no cover
 
     @classmethod
     @pandas_module_level_function_not_implemented()
@@ -717,12 +717,12 @@ def read_sql_query(
         con,
         **kwargs,
     ):
-        pass
+        pass  # pragma: no cover
 
     @classmethod
     @pandas_module_level_function_not_implemented()
     def read_spss(cls, path, usecols, convert_categoricals, dtype_backend):
-        pass
+        pass  # pragma: no cover
 
     @classmethod
     @pandas_module_level_function_not_implemented()
@@ -732,4 +732,4 @@ def to_pickle(
         filepath_or_buffer,
         **kwargs,
     ):
-        pass
+        pass  # pragma: no cover
diff --git a/tox.ini b/tox.ini
index d79ecb7f1b3..5544cc15f7f 100644
--- a/tox.ini
+++ b/tox.ini
@@ -1,16 +1,18 @@
 [coverage:report]
 skip_covered = False
 show_missing = True
-# TODO: SNOW-1453027 remove omit
+# TODO: SNOW-1453027 remove omit for config and core
 omit = */src/snowflake/snowpark/modin/config/*
        */src/snowflake/snowpark/modin/core/*
+       */src/snowflake/snowpark/modin/plugin/docstrings/*
 [coverage:run]
 branch = true
 parallel = true
 concurrency = multiprocessing
-# TODO: SNOW-1453027 remove omit
+# TODO: SNOW-1453027 remove omit for config and core
 omit = */src/snowflake/snowpark/modin/config/*
        */src/snowflake/snowpark/modin/core/*
+       */src/snowflake/snowpark/modin/plugin/docstrings/*
 [coverage:paths]
 source = src/snowflake/snowpark
          */.tox/*/lib/python*/site-packages/snowflake/snowpark