keep app id (project hash) the same even after re-init #2195

tgberkeley · 2023-11-17T23:40:50Z

All Submissions:

Have you followed the guidelines stated in CONTRIBUTING.md file?
Have you checked to ensure there aren't any other open Pull Requests for the desired changed?

Type of change

Please delete options that are not relevant.

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
This change requires a documentation update

New Feature Submission:

Does your submission pass the tests?
Have you linted your code locally prior to submission?

Changes To Core Features:

Have you added an explanation of what your changes do and why you'd like us to include them?
Have you written new tests for your core changes, as applicable?
Have you successfully ran tests with your changes locally?

After these steps, you're ready to open a pull request.

a. Give a descriptive title to your PR.

b. Describe your changes.

c. Put `closes #XXXX` in your comment to auto-close the issue that your PR fixes (if such).

picklelo · 2023-11-18T00:35:02Z

reflex/utils/prerequisites.py

@@ -278,20 +278,36 @@ def initialize_app_directory(app_name: str, template: constants.Templates.Kind):
    )


+def get_project_hash_if_exists():


We can call this get_project_hash and add a type annotation

def get_project_hash_if_exists() -> str | None:

picklelo · 2023-11-18T00:36:05Z

reflex/utils/prerequisites.py

@@ -278,20 +278,36 @@ def initialize_app_directory(app_name: str, template: constants.Templates.Kind):
    )


+def get_project_hash_if_exists():
+    """Check if the reflex.json file exists in .web folder and 


nit: we can simplify the docstring "Get the project hash from the reflex.json file."

the rest of the comment can go in the place where we actually do the overriding

picklelo · 2023-11-18T00:36:56Z

reflex/utils/prerequisites.py

+            data = json.load(file)
+            project_hash = data["project_hash"]
+            return project_hash
+    else:


Don't need the else since the if returns. Also generally may be cleaner to do the early return cases first:

if not os.path.exists(...): return None with open ...

picklelo · 2023-11-18T00:37:25Z

reflex/utils/prerequisites.py

 def initialize_web_directory():
    """Initialize the web directory on reflex init."""
    console.log("Initializing the web directory.")

-    path_ops.cp(constants.Templates.Dirs.WEB_TEMPLATE, constants.Dirs.WEB)
+    project_hash = get_project_hash_if_exists()


We can add the comment here about saving the project hash so its not overridden

picklelo · 2023-11-18T00:38:33Z

reflex/utils/prerequisites.py

@@ -315,11 +331,15 @@ def initialize_package_json():
        file.write(code)


-def init_reflex_json():
+def init_reflex_json(project_hash):


Add type annotations, and update docstrings

picklelo · 2023-11-20T19:17:50Z

reflex/utils/prerequisites.py

+    """Get the project hash from the reflex.json file if the file exists.
+
+    Returns:
+        project_hash (int): The app hash.


nit: don't need the (int) in the docstring as we are using type annotations

picklelo · 2023-11-20T19:18:38Z

reflex/utils/prerequisites.py

-    console.debug(f"Setting project hash to {project_hash}.")
+def init_reflex_json(project_hash: int | None):
+    """Write the hash of the Reflex project to a REFLEX_JSON.
+    Re-use the hash if one is already created, therefore do not


nit: add a blank line after the first line when expanding the docstring.

picklelo · 2023-11-20T19:19:01Z

reflex/utils/prerequisites.py

+    .
+
+    Args:
+        project_hash (int): The app hash.


Don't need the annotation here also

keep app id (project hash) the same even after re-init

8cccfe0

tgberkeley requested a review from picklelo November 17, 2023 23:41

picklelo requested changes Nov 18, 2023

View reviewed changes

updates for precommit

fd2cd94

picklelo reviewed Nov 20, 2023

View reviewed changes

Tom Gotsman added 2 commits November 20, 2023 11:20

minor style update

5a92025

minor style update2

94bc39c

picklelo approved these changes Nov 20, 2023

View reviewed changes

picklelo merged commit 5198dae into main Nov 20, 2023
45 checks passed

masenf deleted the tracking-retention branch December 6, 2023 22:19

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

keep app id (project hash) the same even after re-init #2195

keep app id (project hash) the same even after re-init #2195

tgberkeley commented Nov 17, 2023 •

edited

Loading

picklelo Nov 18, 2023

tgberkeley Nov 20, 2023

picklelo Nov 18, 2023

tgberkeley Nov 20, 2023

picklelo Nov 18, 2023

tgberkeley Nov 20, 2023

picklelo Nov 18, 2023

picklelo Nov 18, 2023

tgberkeley Nov 20, 2023

picklelo Nov 20, 2023

picklelo Nov 20, 2023

tgberkeley Nov 20, 2023

picklelo Nov 20, 2023

tgberkeley Nov 20, 2023

		@@ -278,20 +278,36 @@ def initialize_app_directory(app_name: str, template: constants.Templates.Kind):
		)


		def get_project_hash_if_exists():

keep app id (project hash) the same even after re-init #2195

keep app id (project hash) the same even after re-init #2195

Conversation

tgberkeley commented Nov 17, 2023 • edited Loading

All Submissions:

Type of change

New Feature Submission:

Changes To Core Features:

After these steps, you're ready to open a pull request.

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

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

tgberkeley commented Nov 17, 2023 •

edited

Loading