refactor(copy): rename exclude_from to _exclude_from and reorder docstring alphabetically

Renamed the parameter `exclude_from` to `_exclude_from` to follow HPCCM
convention that container framework-specific options begin with an underscore
(e.g., `_chown`, `_mkdir`, `_post`).

Also reordered the parameter documentation block in `copy.py` to maintain
alphabetical order within the class docstring for consistency.

Author: allansp84

hpccm/primitives/copy.py

@@ -44,6 +44,17 @@ class copy(object):
 
     dest: Path in the container image to copy the file(s)
 
+    _exclude_from: String or list of strings.  One or more filenames
+    containing rsync-style exclude patterns (e.g., `.apptainerignore`).
+    Only used when building for Singularity or Apptainer.  If specified,
+    the copy operation is emitted in the `%setup` section using
+    `rsync --exclude-from=<file>` rather than the standard `%files`
+    copy directive.  This enables selective exclusion of files and
+    directories during the image build, for example to omit large data
+    files, caches, or temporary artifacts.  Multiple exclusion files may
+    be provided as a list or tuple.  The default is an empty list
+    (Singularity specific).
+
     files: A dictionary of file pairs, source and destination, to copy
     into the container image.  If specified, has precedence over
     `dest` and `src`.
@@ -66,17 +77,6 @@ class copy(object):
 
     src: A file, or a list of files, to copy
 
-    exclude_from: String or list of strings.  One or more filenames
-    containing rsync-style exclude patterns (e.g., `.apptainerignore`).
-    Only used when building for Singularity or Apptainer.  If specified,
-    the copy operation is emitted in the `%setup` section using
-    `rsync --exclude-from=<file>` rather than the standard `%files`
-    copy directive.  This enables selective exclusion of files and
-    directories during the image build, for example to omit large data
-    files, caches, or temporary artifacts.  Multiple exclusion files may
-    be provided as a list or tuple.  The default is an empty list
-    (Singularity specific).
-
     # Examples
 
     ```python
@@ -92,7 +92,7 @@ class copy(object):
     ```
 
     ```python
-    copy(src='.', dest='/opt/app', exclude_from='.apptainerignore')
+    copy(src='.', dest='/opt/app', _exclude_from='.apptainerignore')
     ```
 
     """
@@ -111,7 +111,7 @@ def __init__(self, **kwargs):
         self._post = kwargs.get('_post', '')  # Singularity specific
         self.__src = kwargs.get('src', '')
 
-        ef = kwargs.get('exclude_from', None)
+        ef = kwargs.get('_exclude_from', None)
         if ef is None:
             self.__exclude_from = []
         elif isinstance(ef, (list, tuple)):

test/test_copy.py

@@ -258,8 +258,8 @@ def test_from_temp_staging(self):
 
     @singularity
     def test_exclude_from_single_singularity(self):
-        """rsync-based copy with exclude_from (single source)"""
-        c = copy(src='.', dest='/opt/app', exclude_from='.apptainerignore')
+        """rsync-based copy with _exclude_from (single source)"""
+        c = copy(src='.', dest='/opt/app', _exclude_from='.apptainerignore')
         recipe = str(c)
         self.assertIn('%setup', recipe)
         self.assertIn('rsync -av', recipe)
@@ -270,9 +270,9 @@ def test_exclude_from_single_singularity(self):
 
     @singularity
     def test_exclude_from_multiple_singularity(self):
-        """rsync-based copy with multiple exclude_from files"""
+        """rsync-based copy with multiple _exclude_from files"""
         c = copy(src='data', dest='/opt/data',
-                 exclude_from=['.ignore1', '.ignore2'])
+                 _exclude_from=['.ignore1', '.ignore2'])
         recipe = str(c)
         self.assertIn('%setup', recipe)
         self.assertIn('rsync -av', recipe)
@@ -284,8 +284,8 @@ def test_exclude_from_multiple_singularity(self):
 
     @docker
     def test_exclude_from_docker_ignored(self):
-        """exclude_from ignored in Docker context"""
-        c = copy(src='.', dest='/opt/app', exclude_from='.apptainerignore')
+        """_exclude_from ignored in Docker context"""
+        c = copy(src='.', dest='/opt/app', _exclude_from='.apptainerignore')
         recipe = str(c)
         self.assertIn('COPY', recipe)
         self.assertNotIn('rsync', recipe)