Checkout edits #249

kiihne-noaa · 2024-11-05T17:15:38Z

Describe your changes

Added logic to fre pp Checkout to account for branch changes

Issue ticket number and link (if applicable)

issue 174

syntax fixed on line 36

switched to checking out tag 2024.01

…i into checkout_edits

ceblanton · 2024-11-05T17:53:59Z

There are 4 logical pathways that we want for fre pp checkout.

It's cheating a little to do this, but git helpfully conflates branches and tags. So everywhere we use branch or tag, we should try to use "branch/tag" or "branch or tag".

If --branch is not specified, and ~/cylc-src/NAME doesn't exist, then:

Determine the default tag, with fre --version.

Checkout that with git clone -b $tag

If --branch is specified, and ~/cylc-src/NAME doesn't exist, then:

fre pp clone --branch=shield https://github.com/NOAA-GFDL/fre-workflows

Check out the requested branch/tag with git clone -b $user_request

If --branch is not specified, and ~/cylc-src/NAME exists, then:

Determine the default tag, with fre --version

Determine the branch and tag of ~/cylc-src/NAME. If either match, then OK. If none match, then give an error with the mismatch.

You can get the branch of ~/cylc-src/NAME with git branch and the tag with git describe. e.g.

git clone https://github.com/NOAA-GFDL/fre-workflows -b 2024.01 my-workflows
Cloning into 'my-workflows'...
remote: Enumerating objects: 5680, done.
remote: Counting objects: 100% (450/450), done.
remote: Compressing objects: 100% (73/73), done.
remote: Total 5680 (delta 391), reused 410 (delta 365), pack-reused 5230 (from 1)
Receiving objects: 100% (5680/5680), 1.26 MiB | 5.88 MiB/s, done.
Resolving deltas: 100% (3136/3136), done.
Note: switching to '3d75b570fc39ad25f20dfbf450ed875ed754968d'.

You are in 'detached HEAD' state. You can look around, make experimental
changes and commit them, and you can discard any commits you make in this
state without impacting any branches by switching back to a branch.

If you want to create a new branch to retain commits you create, you may
do so (now or later) by using -c with the switch command. Example:

  git switch -c <new-branch-name>

Or undo this operation with:

  git switch -

Turn off this advice by setting config variable advice.detachedHead to false

Updating files: 100% (178/178), done.

(fre-test) c2b:~%>cd my-workflows
(fre-test) c2b:~/my-workflows%>git describe
2024.01

If --branch is specified, and ~/cylc-src/NAME exists, then:

Verify that either the branch (git branch) or tag (git describe)

in ~/cylc-src/NAME matches the user request. If not, give the mismatch error.

ceblanton · 2024-11-05T17:56:50Z

I pip-installed your branch to give it a try on the 4 logical pathways, and it failed with a IndexError. Do you see this on your end?

(fre-test) c2b:~%>fre pp checkout -e myexp -p myplat -t mytar   
Traceback (most recent call last):
  File "/nbhome/fms/conda/envs/fre-test/bin/fre", line 10, in <module>
    sys.exit(fre())
  File "/nbhome/fms/conda/envs/fre-test/lib/python3.9/site-packages/click/core.py", line 1157, in __call__
    return self.main(*args, **kwargs)
  File "/nbhome/fms/conda/envs/fre-test/lib/python3.9/site-packages/click/core.py", line 1078, in main
    rv = self.invoke(ctx)
  File "/nbhome/fms/conda/envs/fre-test/lib/python3.9/site-packages/click/core.py", line 1688, in invoke
    return _process_result(sub_ctx.command.invoke(sub_ctx))
  File "/nbhome/fms/conda/envs/fre-test/lib/python3.9/site-packages/click/core.py", line 1688, in invoke
    return _process_result(sub_ctx.command.invoke(sub_ctx))
  File "/nbhome/fms/conda/envs/fre-test/lib/python3.9/site-packages/click/core.py", line 1434, in invoke
    return ctx.invoke(self.callback, **ctx.params)
  File "/nbhome/fms/conda/envs/fre-test/lib/python3.9/site-packages/click/core.py", line 783, in invoke
    return __callback(*args, **kwargs)
  File "/nbhome/fms/conda/envs/fre-test/lib/python3.9/site-packages/click/decorators.py", line 33, in new_func
    return f(get_current_context(), *args, **kwargs)
  File "/home/c2b/.local/lib/python3.9/site-packages/fre/pp/frepp.py", line 125, in checkout
    context.forward(checkoutTemplate)
  File "/nbhome/fms/conda/envs/fre-test/lib/python3.9/site-packages/click/core.py", line 804, in forward
    return __self.invoke(__cmd, *args, **kwargs)
  File "/nbhome/fms/conda/envs/fre-test/lib/python3.9/site-packages/click/core.py", line 783, in invoke
    return __callback(*args, **kwargs)
  File "/home/c2b/.local/lib/python3.9/site-packages/fre/pp/checkoutScript.py", line 89, in checkoutTemplate
    return _checkoutTemplate(experiment, platform, target, branch)
  File "/home/c2b/.local/lib/python3.9/site-packages/fre/pp/checkoutScript.py", line 39, in _checkoutTemplate
    local_branch_name = branch_names.stdout.split()[1]
IndexError: list index out of range

ceblanton · 2024-11-05T18:02:13Z

fre/__init__.py

@@ -0,0 +1 @@
+__version__ = '2024.01'


Is this used? I think it makes sense to store the version here instead of setup.py, but want to avoid duplication.

i think the idea is to check the fre-cli version below with a pythonic approach, but i'm wondering if this idea is actually dead-on-arrival the more i think about it...

fre/pp/checkoutScript.py

ilaflott · 2024-11-08T20:08:22Z

you'll wanna peek at the click argument default values as well

ceblanton · 2024-11-08T20:13:20Z

fre/pp/checkoutScript.py

+        if os.path.isdir(name): #scenario 4
+            os.chdir(name)
+            name_path_tag=subprocess.run(["git","describe","--tags"],capture_output=True, text=True).stdout
+            name_path_branch=subprocess.run(["git","branch"],capture_output=True, text=True).stdout.split()[1]


I'm worried about the split()[1] here.. is it safe and will it always be the second member?

git branch gives a lot of output. e.g.

(docs) c2b:~/git/fre-cli%>git branch 204-improve-fre-cmor-run-functionality CMORPytestUpdates catalog-merge checkout_edits * docs main update-docs

When I experimented locally, I always saw it give * branch_name as the first entry. But if its different on different places, I can generalize so it splits at *, and then splits the original way.

I am implementing changes to generalize this. When working locally, I only ever saw * current_branch' as the top item. But for other scenarios, new push should fix that.

ceblanton · 2024-11-08T20:15:24Z

fre/pp/checkoutScript.py

-            sys.exit(stop_report)
-            return 1
+    # branch and version parameters
+    default_tag = subprocess.run(["fre","--version"],capture_output=True, text=True).stdout.split()[2]


The tag retrieved from fre --version has a one digit month but the fre-workflows (and fre-cli) tags are two-digit month. So this

c2b:~%>fre --version
fre-cli | 2024.1

needs to be expanded to 2024.01 to be used as a tag for fre-workflows.

ceblanton · 2024-11-08T20:19:28Z

fre/pp/checkoutScript.py

@@ -20,7 +20,7 @@

 #############################################

-def _checkoutTemplate(experiment, platform, target):
+def _checkoutTemplate(experiment, platform, target, branch='empty'):


This looks fine to me (as a not-quite python person), but it might be more pythonic to set the default to be None. (We can always improve it later)

def _checkoutTemplate(experiment, platform, target, branch=None):

ceblanton · 2024-11-08T20:23:12Z

fre/pp/checkoutScript.py

+                sys.exit(stop_report)
+                return 1
+        else:   #scenario 1
+            subprocess.run(f'git checkout tags/{default_tags}')


You want a git clone here instead, just like the one above.

git clone --branch={default_tag} https://github.com/NOAA-GFDL/fre-cli.git

ilaflott · 2024-11-12T19:13:04Z

fre/pp/checkoutScript.py

@@ -36,11 +36,12 @@ def _checkoutTemplate(experiment, platform, target, branch='empty'):

    # branch and version parameters
    default_tag = subprocess.run(["fre","--version"],capture_output=True, text=True).stdout.split()[2]
-    if branch != 'empty':   
+    if branch == None:   


nit: branch is None instead of branch == None

Avery Kiihne and others added 10 commits October 2, 2024 14:55

checkout updated for issue #174

e063d85

Update checkoutScript.py

6e701aa

syntax fixed on line 36

Update checkoutScript.py

b9c9d01

switched to checking out tag 2024.01

added exit if local branch is not branch request

582592f

fixed bracket

a2f536f

Merge branch 'main' into checkout_edits

6919bd0

tags version

3a7f378

Update __init__.py with version

0ac0322

added version checker #174

8a67e19

Merge branch 'precompute-workflow.247' of github.com:NOAA-GFDL/fre-cl…

438492c

…i into checkout_edits

ceblanton reviewed Nov 5, 2024

View reviewed changes

singhd789 requested review from singhd789 and removed request for singhd789 November 5, 2024 18:21

ilaflott reviewed Nov 5, 2024

View reviewed changes

fre/pp/checkoutScript.py Outdated Show resolved Hide resolved

Avery Kiihne added 2 commits November 6, 2024 16:50

git fixes

64d5cc8

wrapper logic reworked #174

f1756d8

ceblanton reviewed Nov 8, 2024

View reviewed changes

kiihne-noaa added 3 commits November 8, 2024 16:13

Update checkoutScript.py

f161cd7

varous small improvemnets to address comments

1c0a531

Update checkoutScript.py

f91514c

ilaflott reviewed Nov 12, 2024

View reviewed changes

kiihne-noaa added 3 commits November 13, 2024 11:16

reviewing checkoutScript.py

fe1078d

syntax change

a6d6a82

removed outdated aspects

a34f559

Avery Kiihne and others added 3 commits November 13, 2024 12:38

testing

19a7e2a

spelling change

8f8d17f

Update checkoutScript.py

e658eb7

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Checkout edits #249

Checkout edits #249

kiihne-noaa commented Nov 5, 2024

ceblanton commented Nov 5, 2024 •

edited

Loading

ceblanton commented Nov 5, 2024

ceblanton Nov 5, 2024

ilaflott Nov 5, 2024

ilaflott commented Nov 8, 2024

ceblanton Nov 8, 2024

kiihne-noaa Nov 8, 2024

kiihne-noaa Nov 8, 2024

ceblanton Nov 8, 2024

ceblanton Nov 8, 2024

ceblanton Nov 8, 2024

ilaflott Nov 12, 2024

Checkout edits #249

Are you sure you want to change the base?

Checkout edits #249

Conversation

kiihne-noaa commented Nov 5, 2024

Describe your changes

Issue ticket number and link (if applicable)

ceblanton commented Nov 5, 2024 • edited Loading

ceblanton commented Nov 5, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ilaflott commented Nov 8, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ceblanton commented Nov 5, 2024 •

edited

Loading