Add function to get list of worksheet names

Get worksheet names, but by defualt exclude hidden worksheets.

Author: nudowding

BUILD.bazel

@@ -1,15 +1,16 @@
 load("@bazel_gazelle//:def.bzl", "gazelle")
 load("@pypi//:requirements.bzl", "all_whl_requirements")
-load("@rules_python//python:pip.bzl", "compile_pip_requirements")
 load("@rules_python//python:packaging.bzl", "py_package", "py_wheel")
+load("@rules_python//python:pip.bzl", "compile_pip_requirements")
 load("@rules_python_gazelle_plugin//manifest:defs.bzl", "gazelle_python_manifest")
 load("@rules_python_gazelle_plugin//modules_mapping:def.bzl", "modules_mapping")
 
 compile_pip_requirements(
     name = "requirements",
     srcs = ["pyproject.toml"],
-    requirements_darwin="requirements_darwin.txt",
-    requirements_linux="requirements_linux.txt",
+    requirements_darwin = "requirements_darwin.txt",
+    requirements_linux = "requirements_linux.txt",
+    requirements_txt = "requirements.txt",
 )
 
 # This rule fetches the metadata for python packages we depend on. That data is
@@ -63,20 +64,18 @@ gazelle(
 
 # gazelle:exclude samples
 # gazelle:python_ignore_files setup.py
-# gazelle:resolve py lxml.etree @pypi//lxml
 # gazelle:python_binary_naming_convention $package_name$
 # gazelle:python_library_naming_convention $package_name$
 
-
 # Publishing
 
 py_wheel(
     name = "wheel",
     distribution = "tableaudocumentapi_ntnx",
     homepage = "https://github.com/nutanix-corp/ng-common-utilities/tree/tableaudocumentapi_ntnx/tableaudocumentapi_ntnx",
-    version = '0.11.1',
-    deps = ["//tableaudocumentapi:tableaudocumentapi"],
     requires = [
-        "lxml"
+        "lxml",
     ],
+    version = "0.11.1",
+    deps = ["//tableaudocumentapi"],
 )

MODULE.bazel.lock

@@ -4,7 +4,62 @@
 #   bazel run //:gazelle_python_manifest.update
 
 manifest:
-  modules_mapping: {}
+  modules_mapping:
+    IPython: ipython
+    asttokens: asttokens
+    backports: backports.tarfile
+    certifi: certifi
+    charset_normalizer: charset_normalizer
+    click: click
+    click_completion: click_completion
+    click_default_group: click_default_group
+    cucumber_tag_expressions: cucumber_tag_expressions
+    ddc459050edb75a05942__mypyc: tomli
+    decorator: decorator
+    docutils: docutils
+    executing: executing
+    id: id
+    idna: idna
+    importlib_metadata: importlib_metadata
+    ipython_pygments_lexers: ipython_pygments_lexers
+    jaraco.classes: jaraco.classes
+    jaraco.context: jaraco.context
+    jaraco.functools: jaraco.functools
+    jedi: jedi
+    jinja2: jinja2
+    keyring: keyring
+    lxml: lxml
+    markdown_it: markdown_it_py
+    markupsafe: MarkupSafe
+    matplotlib_inline: matplotlib_inline
+    mdurl: mdurl
+    more_itertools: more_itertools
+    nh3: nh3
+    packaging: packaging
+    parso: parso
+    pexpect: pexpect
+    pluggy: pluggy
+    pprintpp: pprintpp
+    prompt_toolkit: prompt_toolkit
+    ptyprocess: ptyprocess
+    pure_eval: pure_eval
+    pygments: pygments
+    readme_renderer: readme_renderer
+    requests: requests
+    requests_toolbelt: requests_toolbelt
+    rfc3986: rfc3986
+    rich: rich
+    shellingham: shellingham
+    six: six
+    stack_data: stack_data
+    tomli: tomli
+    traitlets: traitlets
+    twine: twine
+    typing_extensions: typing_extensions
+    urllib3: urllib3
+    ward: ward
+    wcwidth: wcwidth
+    zipp: zipp
   pip_repository:
     name: pypi
-integrity: 745d8c975f02ab21130991aa2f26519c2a9c68235981f021380ed5e1945d0d73
+integrity: e80d37e224056e922a98d7fc2db08be95496f95137ebadc6df4a2f9d4123b0a2

gazelle_python.yaml

@@ -5,4 +5,5 @@ dependencies = [
              "ipython",
              "lxml",
              "twine",
+             "ward",
 ]

pyproject.toml

@@ -185,6 +185,23 @@ def remove_dashboard_by_name(self, name: str) -> Element:
         self._remove_window(name)
         return dashboard
 
+    def worksheet_names(self, hidden=False):
+        """Get names of worksheets
+
+        By default the names of hidden worksheets are not returned. Use hidden=True to see all worksheets.
+        """
+        windows = {}
+        for elt in self.__get_section("windows"):
+            windows[elt.attrib["name"]] = elt
+        names = []
+        for name in self._worksheets:
+            window = windows[name]
+            hidden = window.attrib.get("hidden")
+            if hidden and hidden == 'true':
+                continue
+            names.append(name)
+        return names
+
     def remove_worksheet_by_name(self, name: str) -> Element:
         """Remove worksheet identified by 'name',
 

requirements.txt

@@ -66,3 +66,14 @@ py_test(
         "//test/assets",
     ],
 )
+
+py_test(
+    name = "test_nutanix",
+    srcs = ["test_nutanix.py", "runner.py"],
+    main = "runner.py",
+    deps = [
+        "//tableaudocumentapi",
+        "@pypi//ward",
+    ],
+    data = ["//test/assets:workbooks"]
+)

requirements_darwin.txt

@@ -8,3 +8,10 @@ py_library(
     ],
     visibility = ["//:__subpackages__"],
 )
+
+
+filegroup(
+    name="workbooks",
+    srcs = glob(["*.twb", "*.twbx"]),
+    visibility = ["//:__subpackages__"]
+)

tableaudocumentapi/workbook.py

@@ -0,0 +1,8 @@
+from ward import test
+
+from tableaudocumentapi import Workbook
+
+@test("only show visible worksheets")
+def _():
+    wb = Workbook("test/assets/sr-backlog.twb")
+    assert wb.worksheet_names() == ['Sum SR State']