prepare for 0.3.11 release

Merge pull request #77 from aeisenbarth/filter-empty-folders
Filter directories without h5ad files
2026-09-16 21:37:56 +08:00 · 2023-07-09 19:27:32 -04:00 · 2023-07-09 07:04:06 -06:00 · 2023-07-09 08:25:27 -04:00 · 2023-07-09 06:05:50 -06:00 · 2023-07-09 06:03:33 -06:00
8 changed files with 82 additions and 4 deletions
--- a/Changelog.md
+++ b/Changelog.md
@@ -1,6 +1,8 @@
 # 0.3.11

 * #81 added support for gene sets
+* #79 added example for cellxgene-gateway customized docker image
+* #78 prune directories that do not contain h5ad files

 # 0.3.10

--- a/cellxgene_gateway/init.py
+++ b/cellxgene_gateway/init.py
@@ -7,4 +7,4 @@
 # OR CONDITIONS OF ANY KIND, either express or implied. See the License for
 # the specific language governing permissions and limitations under the License.

-__version__ = "0.3.10"
+__version__ = "0.3.11"
--- a/cellxgene_gateway/items/file/fileitem_source.py
+++ b/cellxgene_gateway/items/file/fileitem_source.py
@@ -68,7 +68,7 @@ class FileItemSource(ItemSource):

        return item_tree

-    def scan_directory(self, subpath="") -> dict:
+    def scan_directory(self, subpath: str = "") -> ItemTree:
        base_path = os.path.join(self.base_path, subpath)

        if not os.path.exists(base_path):
@@ -105,6 +105,11 @@ class FileItemSource(ItemSource):
            branches = [
                self.scan_directory(os.path.join(subpath, subdir)) for subdir in subdirs
            ]
+            # Exclude branches without files as leaves. Since traversal is applied pre-order,
+            # branch.branches has already been processed and we don't need to check deeper nesting.
+            branches = [
+                branch for branch in branches if branch.items or branch.branches
+            ]

        return ItemTree(subpath, items, branches)

--- a/cellxgene_gateway/items/s3/s3item_source.py
+++ b/cellxgene_gateway/items/s3/s3item_source.py
@@ -116,6 +116,9 @@ class S3ItemSource(ItemSource):
        branches = None
        if len(subdir_keys) > 0:
            branches = [self.scan_directory(key) for key in subdir_keys]
+            branches = [
+                branch for branch in branches if branch.items or branch.branches
+            ]

        return ItemTree(directory_key, items, branches)

--- a/examples/customized_docker_image/Dockerfile
+++ b/examples/customized_docker_image/Dockerfile
@@ -0,0 +1,14 @@
+FROM python:3.9
+
+RUN pip install cellxgene-gateway 'MarkupSafe<2.1'
+
+COPY customize_ui.sh customize_ui.sh
+RUN CELLXGENE_GATEWAY_DIR=/usr/local/lib/python3.9/site-packages/cellxgene_gateway . ./customize_ui.sh
+
+ENV CELLXGENE_DATA=/cellxgene-data
+ENV CELLXGENE_LOCATION=/usr/local/bin/cellxgene
+EXPOSE 5005
+
+RUN mkdir /cellxgene-data
+
+CMD ["cellxgene-gateway"]
--- a/examples/customized_docker_image/README.md
+++ b/examples/customized_docker_image/README.md
@@ -0,0 +1,14 @@
+# Purpose
+
+This is a simple example of how to make a small script to customize the UI of cellxgene-gateway. The script that does the customization is `customize_ui.sh`, it simply makes the main header green using CSS but you could do anything you want there (including adding more script tags, etc).
+
+# Usage
+
+```
+docker build -t cellxgene_custom .
+CELLXGENE_DATA=`pwd`/../../../cellxgene_data
+docker run -p 5005:5005 --mount src=$CELLXGENE_DATA,target=/cellxgene-data,type=bind cellxgene_custom
+```
+
+If you now open http://localhost:5005 you should see a green cellxgene gateway header.
+
--- a/examples/customized_docker_image/customize_ui.sh
+++ b/examples/customized_docker_image/customize_ui.sh
@@ -0,0 +1,3 @@
+# make the header bright green
+find "${CELLXGENE_GATEWAY_DIR}/templates" -name index.html -exec sed -i -e 's/<head>/<head>\
+> <style> header h3 {color: #0F0;} <\/style>/g' {} \;
--- a/tests/test_filecrawl.py
+++ b/tests/test_filecrawl.py
@@ -1,4 +1,5 @@
 import unittest
+from collections import defaultdict
 from unittest.mock import MagicMock, patch

 from cellxgene_gateway.filecrawl import (
@@ -48,12 +49,48 @@ class TestRenderItemSource(unittest.TestCase):


 class TestRenderItemTree(unittest.TestCase):
+    def setUp(self):
+        from cellxgene_gateway.gateway import app
+
+        self.app = app
+        self.app_context = self.app.test_request_context()
+        self.app_context.push()
+
    @patch("cellxgene_gateway.items.file.fileitem_source.FileItemSource")
    def test_GIVEN_deep_nested_dirs_THEN_includes_dirs_in_output(self, item_source):
        item_source.name = "FakeSource"
-        item_tree = ItemTree("foo/bar/baz", [], [])
+        item_source.get_annotations_subpath = lambda _: "FakeAnnotations"
+        file_item = FileItem(
+            subpath="foo/bar/baz", name="file.h5ad", type=ItemType.h5ad
+        )
+        item_tree = ItemTree("foo/bar/baz", [file_item], [])
        rendered = render_item_tree(item_tree, item_source)
        self.assertEqual(
            rendered,
-            "<li><a href='/filecrawl/foo/bar/baz?source=FakeSource'>baz</a><ul></ul></li>",
+            "<li><a href='/filecrawl/foo/bar/baz?source=FakeSource'>baz</a><ul>"
+            "<li> <a href='/source/FakeSource/view/foo/bar/baz/file.h5ad/'>file.h5ad</a>"
+            "  | annotations: <a class='new' href='/source/FakeSource/view/FakeAnnotations'>new</a>"
+            "</li></ul></li>",
+        )
+
+    @patch(
+        "os.listdir",
+        side_effect=lambda parent: defaultdict(
+            list, {"tmp": ["foo"], "tmp/foo": ["bar"]}
+        )[parent],
+    )
+    @patch("os.path.exists", return_value=True)
+    def test_GIVEN_dirs_without_h5ad_THEN_excludes_dirs_in_output(
+        self, listdir, exists
+    ):
+        # Directories:
+        # - tmp
+        #   - foo
+        #     - bar (no h5ad files)
+        item_source = FileItemSource("tmp", name="local")
+        item_tree = item_source.list_items("foo")
+        rendered = render_item_tree(item_tree, item_source)
+        self.assertEqual(
+            rendered,
+            "<li><a href='/filecrawl/foo?source=local'>foo</a><ul></ul></li>",
        )
Author	SHA1	Message	Date
Alok Saldanha	9d10932b06	prepare for 0.3.11 release	2023-07-09 19:27:32 -04:00
Alok Saldanha	c7c156b4cf	Merge pull request #77 from aeisenbarth/filter-empty-folders Filter directories without h5ad files	2023-07-09 07:04:06 -06:00
Alok Saldanha	624d1f8567	#78 Revert "Rename argument "filter" to "subpath"" This reverts commit `fdd6cca297`.	2023-07-09 08:25:27 -04:00
Alok Saldanha	79c3f588b6	Merge pull request #80 from Novartis/79_add_docker_example 79 add docker example	2023-07-09 06:05:50 -06:00
Alok Saldanha	d8fd07572c	Merge pull request #83 from Novartis/81_gene_set_support gene set support	2023-07-09 06:03:33 -06:00
Alok Saldanha	f296efcc55	#79 added cellxgene-data directory so it actually works	2022-12-21 16:02:50 -05:00
Alok Saldanha	facfb27d5c	#79 add simple example to customize cellxgene-gateway ui	2022-12-21 15:42:13 -05:00
Andreas Eisenbarth	6607b15085	Exclude directories having no h5ad files	2022-10-12 17:31:22 +02:00
Andreas Eisenbarth	0e92b73347	Add test case for dirs without h5ad	2022-10-12 17:31:22 +02:00
Andreas Eisenbarth	88b9b815c0	Adjust test case for dirs with h5ad	2022-10-12 17:31:22 +02:00
Andreas Eisenbarth	6ef82b36f1	For running individual tests, make sure flask_util.view_url is callable	2022-10-12 16:36:46 +02:00
Andreas Eisenbarth	fdd6cca297	Rename argument "filter" to "subpath"	2022-10-12 13:40:39 +02:00