Add support for insert Path obj to csv

Author: CBroz1

README.md

@@ -112,15 +112,15 @@ important DataJoint schema or records.
 
 ### API docs
 
-The API documentation can be built using sphinx by running
+The API documentation can be built with mkdocs using the docker compose file in
+`docs/` with the following command:
 
 ``` bash
-pip install sphinx sphinx_rtd_theme 
-(cd docs-api/sphinx && make html)
+MODE="LIVE" PACKAGE=datajoint UPSTREAM_REPO=https://github.com/datajoint/datajoint-python.git HOST_UID=$(id -u) docker compose -f docs/docker-compose.yaml up --build
 ```
 
-Generated docs are written to `docs-api/docs/html/index.html`.
-More details in [docs-api/README.md](docs-api/README.md).
+The site will then be available at `http://localhost/`. When finished, be sure to run
+the same command as above, but replace `up --build` with `down`.
 
 ## Running Tests Locally
 <details>
@@ -141,11 +141,11 @@ HOST_GID=1000
 * Add entry in `/etc/hosts` for `127.0.0.1 fakeservices.datajoint.io`
 * Run desired tests. Some examples are as follows:
 
-| Use Case                     | Shell Code                                                                    |
-| ---------------------------- | ------------------------------------------------------------------------------ |
-| Run all tests                | `nosetests -vsw tests --with-coverage --cover-package=datajoint`                                                              |
-| Run one specific class test       | `nosetests -vs --tests=tests.test_fetch:TestFetch.test_getattribute_for_fetch1`                                                           |
-| Run one specific basic test        | `nosetests -vs --tests=tests.test_external_class:test_insert_and_fetch`                                   |
+| Use Case                     | Shell Code                                                                      |
+| ---------------------------- | ------------------------------------------------------------------------------  |
+| Run all tests                | `nosetests -vsw tests --with-coverage --cover-package=datajoint`                |
+| Run one specific class test  | `nosetests -vs --tests=tests.test_fetch:TestFetch.test_getattribute_for_fetch1` |
+| Run one specific basic test  | `nosetests -vs --tests=tests.test_external_class:test_insert_and_fetch`         |
 
 
 ### Launch Docker Terminal

datajoint/table.py

@@ -6,6 +6,7 @@
 import pandas
 import logging
 import uuid
+import csv
 import re
 from pathlib import Path
 from .settings import config
@@ -345,13 +346,17 @@ def insert(
         """
         Insert a collection of rows.
 
-        :param rows: An iterable where an element is a numpy record, a dict-like object, a
-            pandas.DataFrame, a sequence, or a query expression with the same heading as self.
+        :param rows: Either (a) an iterable where an element is a numpy record, a
+            dict-like object, a pandas.DataFrame, a sequence, or a query expression with
+            the same heading as self, or (b) a pathlib.Path object specifying a path
+            relative to the current directory with a CSV file, the contents of which
+            will be inserted.
         :param replace: If True, replaces the existing tuple.
         :param skip_duplicates: If True, silently skip duplicate inserts.
-        :param ignore_extra_fields: If False, fields that are not in the heading raise error.
-        :param allow_direct_insert: applies only in auto-populated tables. If False (default),
-            insert are allowed only from inside the make callback.
+        :param ignore_extra_fields: If False, fields that are not in the heading raise
+            error.
+        :param allow_direct_insert: applies only in auto-populated tables. If False
+            (default), insert are allowed only from inside the make callback.
 
         Example:
 
@@ -366,6 +371,10 @@ def insert(
                 drop=len(rows.index.names) == 1 and not rows.index.names[0]
             ).to_records(index=False)
 
+        if isinstance(rows, Path):
+            with open(rows, newline="") as data_file:
+                rows = list(csv.DictReader(data_file, delimiter=","))
+
         # prohibit direct inserts into auto-populated tables
         if not allow_direct_insert and not getattr(self, "_allow_insert", True):
             raise DataJointError(

tests/test_university.py

@@ -33,11 +33,9 @@ def test_activate():
         Enroll,
         Grade,
     ):
-        import csv
+        from pathlib import Path
 
-        with open("./data/" + table.__name__ + ".csv") as f:
-            reader = csv.DictReader(f)
-            table().insert(reader)
+        table().insert(Path("./data/" + table.__name__ + ".csv"))
 
 
 def test_fill():