ODM2 / ODM2PythonAPI

A set of Python functions that provides data read/write access to an ODM2 database by leveraging SQLAlchemy.
http://odm2.github.io/ODM2PythonAPI/
BSD 3-Clause "New" or "Revised" License
4 stars 13 forks source link

Create Future deprecation warning for ODM2 modules #145

Closed lsetiawan closed 6 years ago

lsetiawan commented 6 years ago

NOT READY TO BE MERGED

Overview

This is a test of the deprecation for ODM2 module folder.

emiliom commented 6 years ago

@lsetiawan Thanks for taking these steps. I won't be able to review this until late today or tomorrow (it's 12 files changed, and it's more complicated than usual!).

In the meantime, in the warning text, the word "deprecated" is misspelled everywhere as "depricated". You can go ahead and fix that.

emiliom commented 6 years ago

@lsetiawan I have a question for you, that may be a recommendation. I can see that you edited in place 5 modules in the ODM2 directory we're deprecating, and copied/created versions of those modules (plus services/__init__.py) in the new tree hierarchy that starts at the base path level. But as far as I can tell the relocated files (or copies) were created as "new" files, meaning -- and this is the question -- that they won't retain their git commit history; all the history will remain with the files in the old, deprecated ODM2 directory, which will eventually be removed.

Is that interpretation correct? If so, can you re-do this PR to implement exactly the same changes you've submitted, but done in such a way that you maintain the full git history in the new files? ie, we'd still be able to do a git diff to see what's changed relative to any commit of our choice.

Notes to self (my progress status; @lsetiawan, ignore this):

lsetiawan commented 6 years ago

Is that interpretation correct? If so, can you re-do this PR to implement exactly the same changes you've submitted, but done in such a way that you maintain the full git history in the new files? ie, we'd still be able to do a git diff to see what's changed relative to any commit of our choice.

Your interpretation is correct... I'm not sure how to do that in git.

emiliom commented 6 years ago

Is that interpretation correct? If so, can you re-do this PR to implement exactly the same changes you've submitted, but done in such a way that you maintain the full git history in the new files? ie, we'd still be able to do a git diff to see what's changed relative to any commit of our choice.

Your interpretation is correct... I'm not sure how to do that in git.

Ok. Tell me if I'm wrong, but this sequence (order) is what I have in mind:

  1. use git mv to move all the files you're moving from ODM2 to the base path
  2. "manually" copy these files back into the ODM2 directory (it looks like git has no git cp command?)
  3. now apply your edits to each set of modules, just as you did before. But now the git history will stay with the modules that will remain after the ODM2 is removed, not with the modules that will disappear
lsetiawan commented 6 years ago

Okay. I will try that on Friday. Thanks.

lsetiawan commented 6 years ago

Please test this branch anyhow to make sure that the new and old functions actually work if you have some time. Thanks.

emiliom commented 6 years ago

Okay. I will try that on Friday. Thanks.

So, does my suggestion make sense to you?? You're the git expert here, not me!

Please test this branch anyhow to make sure that the new and old functions actually work if you have some time. Thanks.

I'll try, but no promises ...

lsetiawan commented 6 years ago

So, does my suggestion make sense to you?? You're the git expert here, not me!

Yepp. It makes sense, just never done it.

emiliom commented 6 years ago

@lsetiawan are you planning to implement today the PR changes I recommended?

Just trying to see what to expect today. I have a meeting at 2pm at Suzzallo.

lsetiawan commented 6 years ago

@emiliom I am about to do a PR, but it seems like, that didn't workout... The change history is still exactly the same.. hmmm.

emiliom commented 6 years ago

Hmm

lsetiawan commented 6 years ago

Closing this PR, replaced by #147