p4cmd 2.5.0__tar.gz → 2.7.0__tar.gz

{p4cmd-2.5.0 → p4cmd-2.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: p4cmd
-Version: 2.5.0
+Version: 2.7.0
 Summary: Simple P4 python module
 Home-page: https://github.com/nielsvaes/p4cmd
 Author: Niels Vaes

{p4cmd-2.5.0 → p4cmd-2.7.0}/p4cmd/__init__.py

@@ -1,4 +1,4 @@
-VERSION = "2.5.0"
+VERSION = "2.7.0"
 
 from .p4cmd import P4Client
 from .p4file import P4File

{p4cmd-2.5.0 → p4cmd-2.7.0}/p4cmd/p4cmd.py

@@ -51,6 +51,8 @@ class P4Client(object):
             self.server = self.get_p4_setting("P4PORT")
             if self.server is None:
                 raise p4errors.WorkSpaceError("Could not find P4PORT")
+        
+        self.depot_root = self.get_depot_paths([self.perforce_root])[0]
 
     @classmethod
     def from_env(cls, *args, **kwargs):
@@ -304,7 +306,73 @@ class P4Client(object):
             if len(changelists):
                 return True
             return False
+
+    def update_changelist_description(self, changelist, new_description):
+        """
+        Updates the description of an existing changelist.
     
+        :param changelist: *string* or *int* changelist number
+        :param new_description: *string* new description for the changelist
+        :return: *bool* True if successful, False otherwise
+        """
+        
+        # ... not super elegant, but it works
+        try:
+            changelist = self.__ensure_changelist(changelist)
+    
+            # do some formatting so that we have the proper indentation
+            formatted_description = []
+            for line in new_description.split('\n'):
+                formatted_description.append(f"\t{line}")
+            formatted_description = '\n'.join(formatted_description)
+    
+            output = subprocess.check_output(f'p4 change -o {changelist}', shell=True).decode()
+            
+            # Split the output into sections based on field names
+            sections = []
+            current_section = []
+            current_field = None
+            
+            # take the output and start parsing it
+            for line in output.split('\n'):
+                # check if it's a new field
+                if line.strip() and ':' in line and not line.startswith('\t'):
+                    # if it is, save the previous section
+                    if current_field:
+                        sections.append((current_field, current_section))
+                    # now start a new section
+                    current_field = line.split(':', 1)[0].strip()
+                    current_section = [line]
+                else:
+                    # if it's not a new field, add to the current section
+                    current_section.append(line)
+            
+            # add the last section
+            if current_field:
+                sections.append((current_field, current_section))
+            
+            # new remake the Description field with the update description
+            new_output = []
+            for field, section_lines in sections:
+                if field == "Description":
+                    # replace the description section
+                    new_output.append(section_lines[0])  # keep the "Description:" line because perforce needs this
+                    new_output.append(formatted_description)
+                else:
+                    # keep everything else as-is
+                    new_output.extend(section_lines)
+            
+            updated_output = '\n'.join(new_output)
+            
+            # TODO: modify run_cmd to allow input so that commands like this can also run through it.
+            result = subprocess.check_output(f'p4 change -i', input=updated_output.encode(), shell=True).decode()
+            
+            return True
+        except Exception as e:
+            if not self.silent:
+                logging.error(f"Failed to update changelist description: {e}")
+            return False
+        
     @validate_not_empty
     def move_files_to_changelist(self, file_list, changelist="default"):
         """
@@ -594,6 +662,117 @@ class P4Client(object):
 
         return files_and_cl
 
+    @validate_not_empty
+    def shelve_files(self, changelist, file_list=None, revert_after_shelve=False, force=False):
+        """
+        Shelves files in a changelist. If no files are specified, shelves all files in the changelist.
+    
+        :param changelist: *string* or *int* changelist number or description
+        :param file_list: *list* or *None* list of files to shelve. If None, shelves all files in the changelist
+        :param revert_after_shelve: *bool* if True, reverts the files after shelving them
+        :param force: *bool* if True, forces the shelving operation even if files are already shelved
+        :return: *list* of info dictionaries
+        """
+        changelist = self.__ensure_changelist(changelist)
+        
+        # if no files specified, get all files in the changelist
+        if file_list is None:
+            file_list = self.get_files_in_changelist(changelist)
+        else:
+            file_list = convert_to_list(file_list) if not isinstance(file_list, list) else file_list
+            if not self.silent:
+                self.__validate_file_list(file_list)
+        
+        # if there are no files to shelve, return empty list
+        if not file_list:
+            if not self.silent:
+                logging.warning(f"No files to shelve in changelist {changelist}")
+            return []
+        
+        # iuild args list based on options
+        args = ["-c", str(changelist)]
+        if force:
+            args.append("-f")
+        
+        # run the shelve command
+        info_dicts = self.run_cmd("shelve", args=args, file_list=file_list)
+        
+        for info_dict in info_dicts:
+            if self.__get_dict_value(info_dict, "code") == "error" and not self.silent:
+                logging.error(self.__get_dict_value(info_dict, "data"))
+        
+        # revert files if requested
+        if revert_after_shelve and file_list:
+            revert_info_dicts = self.revert_files(file_list)
+            # add revert info to the return data
+            info_dicts.extend(revert_info_dicts)
+        
+        return info_dicts
+
+    def unshelve_files(self, changelist, file_list=None, target_changelist="default", force=False, delete_shelved_files=False):
+        """
+        Unshelves files from a shelved changelist. If no files are specified, unshelves all files.
+    
+        :param changelist: *string* or *int* source changelist number containing shelved files
+        :param file_list: *list* or *None* list of files to unshelve. If None, unshelves all files
+        :param target_changelist: *string* or *int* target changelist to unshelve files into
+        :param force: *bool* if True, forces the unshelve operation even if files are already opened
+        :param delete_shelved_files: *bool* if True, deletes the shelved files after unshelving them
+        :return: *list* of info dictionaries
+        """
+        source_changelist = self.__ensure_changelist(changelist)
+        target_changelist = self.__ensure_changelist(target_changelist)
+        
+        # build the arguments list
+        args = []
+        
+        # add force flag if requested
+        if force:
+            args.append("-f")
+        
+        # add source changelist (required)
+        args.extend(["-s", str(source_changelist)])
+        
+        # add target changelist if specified and not default
+        if target_changelist != "default":
+            args.extend(["-c", str(target_changelist)])
+        
+        # prepare file list if provided
+        if file_list is not None:
+            file_list = convert_to_list(file_list) if not isinstance(file_list, list) else file_list
+            if not self.silent:
+                self.__validate_file_list(file_list)
+        else:
+            file_list = []
+        
+        # run the unshelve command
+        info_dicts = self.run_cmd("unshelve", args=args, file_list=file_list)
+        
+        # check for errors in the unshelve operation
+        has_error = False
+        for info_dict in info_dicts:
+            if self.__get_dict_value(info_dict, "code") == "error" and not self.silent:
+                logging.error(self.__get_dict_value(info_dict, "data"))
+                has_error = True
+        
+        # delete shelved files if requested and unshelve was successful
+        if delete_shelved_files and not has_error:
+            # build the arguments for the shelve -d command
+            delete_args = ["-d", "-c", str(source_changelist)]
+            
+            # if file_list provided, use it for the delete operation as well
+            delete_info_dicts = self.run_cmd("shelve", args=delete_args, file_list=file_list)
+            
+            # check for errors in the delete operation
+            for info_dict in delete_info_dicts:
+                if self.__get_dict_value(info_dict, "code") == "error" and not self.silent:
+                    logging.error(self.__get_dict_value(info_dict, "data"))
+            
+            # add the delete info to the return data
+            info_dicts.extend(delete_info_dicts)
+        
+        return info_dicts
+
     @validate_not_empty
     def add_or_edit_folders(self, folders, include_subfolders=True, changelist="default"):
         """
@@ -1039,6 +1218,6 @@ class P4Client(object):
         # Easy utility to check that the file is underneath the correct perforce root
         # Quicker than waiting for the result of a p4 fstat
         for f in file_list:
-            if not f.lower().startswith(self.perforce_root.lower()):
-                raise Exception(f'{f} is not under perforce root: {self.perforce_root}')
+            if not f.lower().startswith(self.perforce_root.lower()) and not f.lower().startswith(self.depot_root.lower()):
+                raise Exception(f'{f} is not under perforce root: {self.perforce_root}, {self.depot_root}')
 

{p4cmd-2.5.0 → p4cmd-2.7.0}/p4cmd.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: p4cmd
-Version: 2.5.0
+Version: 2.7.0
 Summary: Simple P4 python module
 Home-page: https://github.com/nielsvaes/p4cmd
 Author: Niels Vaes