P4CMD
🌴
A Python Perforce package that doesn't bring in any other packages to work. Relies on p4cli installed on the system.
p4cmd
The p4cmd module holds the P4Client class that allows you to interact with the P4 server.
To instantiate a new client, you either pass it the root path of you Perforce workspace or if the "P4ROOT" system variable is set, you can use the from_env class function
from p4cmd import p4cmd
client = p4cmd.P4Client("~/nisse/projects/raw")
from p4cmd import p4cmd
import os
# settings system variable
os.environ["P4ROOT"] = "~/nisse/projects/raw"
# now we can use from_env
client = p4cmd.P4Client.from_env()
Most of the functions are pretty self explanatory and have docstrings about how they work.
There are 2 functions called file_to_p4files and folder_to_p4files that use the P4File class in p4file.
p4file
This module holds the P4File class that allows you to quickly and easily get information about any file on disk or in the depot.
Usage
Some use case examples to help you on your way.
Checking out files or adding new files. You can mix/match local and depot paths. Add a changelist number or description to put the files in that CL. If you add a description of a changelist that doesn't exist, it will be created.
from p4cmd import p4cmd
root = "~/p4/MyGame"
files = [r"~/p4/MyGame/Raw/Characters/info_file.json",
"//MyGame/Main/Templates/morefiles.json"]
p4 = p4cmd.P4Client(root)
p4.add_or_edit_files(files, changelist="My new changelist")
Seperate edit_files and add_files methods also exist if you need to use them for some reason.
Perforce operations can be quite slow, so if you need to check a bunch of files at once you can use do something like this:
from p4cmd import p4cmd
root = "~/p4/MyGame"
folder = r"~/p4/MyGame/Animations"
p4 = p4cmd.P4Client(root)
p4files = p4.folder_to_p4files(folder)
files_to_sync = []
for p4file in p4files:
if p4file.get_checked_out_by() is not None: # somebody else other than you checked out the file
print("depot path:", p4file.get_depot_file_path())
print("local path:", p4file.get_local_file_path())
print("status:", p4file.get_status())
print("Checked out by:", p4file.get_checked_out_by())
if p4file.needs_syncing():
files_to_sync.append(p4file.get_local_file_path())
p4.sync_files([files_to_sync])
depot path: //MyGame/Main/MyGame/run.fbx
local path: ~/p4/MyGame/MyGame/run.fbx
status: UP_TO_DATE
Checked out by: [email protected]
depot path: //MyGame/Main/MyGame/dance.json
local path: ~/p4/MyGame/MyGame/dance.json
status: NEED_SYNC
folder_to_p4files returns a list of type p4file. A p4file has a bunch of functions to get information about the file and its status. This will get information back about all the files in one go, instead of you having to make a server call for every file on its own.
Getting all your pending changelists:
from p4cmd import p4cmd
root = "~/p4/MyGame"
p4 = p4cmd.P4Client(root)
all_changelists = p4.get_pending_changelists()
[35272, 33160, 32756, 30872, 27277]
Getting changelists with shelved files:
from p4cmd import p4cmd
root = "~/p4/MyGame"
p4 = p4cmd.P4Client(root)
shelved_changelists = [pair[1] for pair in p4.get_shelved_files()]
[30872, 30872, 27277]
Searching in changelist descriptions:
from p4cmd import p4cmd
root = "~/p4/MyGame"
p4 = p4cmd.P4Client(root)
houdini_cls = p4.get_pending_changelists(description_filter="houdini")
[35272, 33160]
Finding an exact changelist:
from p4cmd import p4cmd
root = "~/p4/MyGame"
p4 = p4cmd.P4Client(root)
houdini_anim_cl = p4.get_pending_changelists(description_filter="[houdini tools]", perfect_match_only=True, case_sensitive=True)
[33160]
Listing all the files in a changelist by changelist number:
from p4cmd import p4cmd
root = "~/p4/MyGame"
p4 = p4cmd.P4Client(root)
files = p4.get_files_in_changelist(33160)
//MyGame/Animations/a_pose.fbx
//MyGame/Animations/t_pose.fbx
List all the files in a changelist by changelist description:
from p4cmd import p4cmd
root = "~/p4/MyGame"
p4 = p4cmd.P4Client(root)
files = p4.get_files_in_changelist("[houdini tools]")
//MyGame/Animations/a_pose.fbx
//MyGame/Animations/t_pose.fbx
1 Jan 25, 2022
103 Dec 24, 2022
26 Dec 5, 2022
157 Nov 24, 2022
25 Dec 20, 2021
1 Feb 24, 2022
1 Feb 9, 2022
276 Dec 19, 2022
13 Nov 10, 2022
1 Jul 22, 2022
1 Dec 23, 2021
34 Jun 15, 2022
2 Sep 13, 2022
9 Dec 27, 2022
1 Jan 08, 2022
21 Nov 21, 2022
95 Jan 08, 2023
3 May 16, 2022
5 Oct 29, 2022
2 Dec 09, 2021
10 Oct 28, 2022
261 Jan 03, 2023
64 Aug 04, 2022
2 Aug 15, 2022
6 Mar 25, 2022
1 May 13, 2022
62 Dec 19, 2022
2 Jan 17, 2022
893 Dec 29, 2022