Going back to "fs.cp", happier with "relative semantics" being playbook, absolute paths on filesystem. Corner case now is if you want to copy from the CWD you need to use absolute path.

Author: linsomniac

README.md

@@ -106,7 +106,7 @@ def restart_apache():
     pyinfra.systemd.service(service="apache2", restarted=True)
 
 pyinfra.apt.packages(packages=["apache2"])
-fs.write(src="my-site.conf.j2", path="/etc/apache2/sites-available/my-site.conf").notify(restart_apache)
+fs.cp(src="my-site.conf.j2", path="/etc/apache2/sites-available/my-site.conf").notify(restart_apache)
 fs.ln(src="/etc/apache2/sites-available/my-site.conf", path="/etc/apache2/sites-enabled/", symbolic=True).notify(restart_apache)
 ```
 

docs/for_ansible_users.md

@@ -35,11 +35,11 @@ for item in [
         core.Item(src="foo.cfg.j2", path="/etc/foo/foo.cfg"),
         core.Item(src="bar.cfg.j2", path="/etc/foo/bar.cfg"),
         ]:
-    fs.write(**item)
+    fs.cp(**item)
     #  or:
-    fs.write(src=item.src, path=item.dst)
+    fs.cp(src=item.src, path=item.dst)
     #  or:
-    fs.write(src="{{item.src}}", path="{{item.dst}}")
+    fs.cp(src="{{item.src}}", path="{{item.dst}}")
 ```
 
 The `**item` syntax applies the attributes from `item` as if they are arguments to the

docs/hacking.md

@@ -50,7 +50,7 @@ information to uPlaybook about:
 
 It is a tasks responsibility to determine if the arguments to it specify the existing
 system state, or if a change will be made.  For example, the
-[fs.write()](tasks/fs.md#uplaybook.fs.write) task will check the destination file permissions,
+[fs.cp()](tasks/fs.md#uplaybook.fs.cp) task will check the destination file permissions,
 template the source file and compare it's hash with the existing file, and only apply the
 changes if they are meaningful.
 

docs/playbooks/basics.md

@@ -148,9 +148,9 @@ modules, and writing several configuration files, these all may "notify" the
 def restart_apache():
     core.run("systemctl restart apache2")
 core.run("apt -y install apache2", creates="/etc/apache2").notify(restart_apache)
-fs.write(src="site1.conf.j2", path="/etc/apache2/sites-enabled/site1.conf").notify(restart_apache)
-fs.write(src="site2.conf.j2", path="/etc/apache2/sites-enabled/site2.conf").notify(restart_apache)
-fs.write(src="site3.conf.j2", path="/etc/apache2/sites-enabled/site3.conf").notify(restart_apache)
+fs.cp(src="site1.conf.j2", path="/etc/apache2/sites-enabled/site1.conf").notify(restart_apache)
+fs.cp(src="site2.conf.j2", path="/etc/apache2/sites-enabled/site2.conf").notify(restart_apache)
+fs.cp(src="site3.conf.j2", path="/etc/apache2/sites-enabled/site3.conf").notify(restart_apache)
 core.flush_handlers()
 #  ensure apache is running
 run("wget -O /dev/null http://localhost/")
@@ -167,7 +167,7 @@ core.notify(handler)
 Handlers can be either a single handler function or a list of handlers:
 
 ```python
-fs.write(src="site.conf.j2", path="/etc/apache2/sites-available/site.conf").notify([
+fs.cp(src="site.conf.j2", path="/etc/apache2/sites-available/site.conf").notify([
     a2ensite,
     restart_apache
     ])

docs/running.md

@@ -39,8 +39,8 @@ arguments it takes:
 
 Run `up --up-docs module.task` to get help about a task:
 
-    $ up --up-docs fs.write
-    # fs.write
+    $ up --up-docs fs.cp
+    # fs.cp
 
     Copy the `src` file to `dst`, optionally templating the contents in `src`.
     [...]

docs/templating.md

@@ -69,21 +69,21 @@ in it, but if you do you have these options:
 
 - Use a RawStr
     ```
-    fs.write(src="template.j2", path=core.RawStr("{{filename}}"))
+    fs.cp(src="template.j2", path=core.RawStr("{{filename}}"))
     ```
 - Put the value in a variable that is template expanded:
     ```
     filename = "{{ my weird filename"
-    fs.write(src="template.j2", path="{{filename}}")
+    fs.cp(src="template.j2", path="{{filename}}")
     ```
 - Use the "raw" Jinja2 tag:
     ```
-    fs.write(src="template.j2", path="{{raw}}{{filename}}{{endraw}}")
+    fs.cp(src="template.j2", path="{{raw}}{{filename}}{{endraw}}")
     ```
 
 ## Files with cp()
 
-The `src` file in `fs.write()` will be template expanded (if `template` argument is set to
+The `src` file in `fs.cp()` will be template expanded (if `template` argument is set to
 True, the default).
 
 !!! For Ansible Users

docs/tutorial.md

@@ -214,7 +214,7 @@ for module_name in ["proxy", "uwsgi"]:
     fs.ln(src="/etc/apache2/mods-available/{{ module_name }}.load",
           path="/etc/apache2/mods-enabled",
           symbolic=True).notify(restart_apache)
-fs.write(path="/etc/apache2/sites-available/my-website.conf").notify(restart_apache)
+fs.cp(path="/etc/apache2/sites-available/my-website.conf").notify(restart_apache)
 fs.ln(src="/etc/apache2/sites-available/my-website.conf",
       path="/etc/apache2/sites-enabled",
       symbolic=True).notify(restart_apache)
@@ -226,7 +226,7 @@ Also write the file "my-website/my-website.conf.j2" with the following contents:
 
     #  My uwsgi website
 
-Why do we call the file "my-website.conf.j2"?  By default, `fs.write()` will: use the base
+Why do we call the file "my-website.conf.j2"?  By default, `fs.cp()` will: use the base
 name of the resulting file as the source, and add ".j2" because by default it will do
 Jinja2 template expansion on the file contents.  It can also Jinja2 expand file names as
 well, if doing a recursive write.

examples/new-uplaybook/playbook

@@ -39,8 +39,8 @@ def git_init():
         core.run("git add .")
 
 if ARGS.single_file:
-    fs.write(src="playbook.j2", path=playbook_fs_name)
+    fs.cp(src="playbook.j2", path=playbook_fs_name)
 else:
     fs.mkdir(path=ARGS.playbook_name).notify(git_init)
     with fs.cd(path=ARGS.playbook_name):
-        fs.write(src="playbook.j2", path="playbook")
+        fs.cp(src="playbook.j2", path="playbook")

tests/test_basics/basics.pb

@@ -5,7 +5,7 @@ from uplaybook import fs, core
 fs.rm(path="testdir", recursive=True)
 fs.mkdir(path="testdir")
 with fs.cd(path="testdir"):
-    fs.write(path="testfile")
+    fs.cp(path="testfile")
     assert fs.exists("testfile")
 
 core.run(command="date")

tests/test_basics/notify.pb

@@ -7,7 +7,7 @@ fs.rm(path="testdir", recursive=True)
 fs.mkdir(path="testdir")
 
 core.notify(lambda: fs.rm(path="testdir", recursive=True))
-fs.write(path="testdir/testfile")
+fs.cp(path="testdir/testfile")
 assert fs.exists("testdir/testfile")
 core.flush_handlers()
 assert not fs.exists("testdir/testfile")