Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deprecate IDOM #4254

Closed
wants to merge 2 commits into from
Closed

Deprecate IDOM #4254

wants to merge 2 commits into from

Conversation

philippjfr
Copy link
Member

@philippjfr philippjfr commented Jan 6, 2023

I've decided to deprecate the IDOM pane. IDOM is a cool project but after I initially implemented it on top of preact the architecture changed significantly which effectively meant that we could only support older versions. I think supporting it would still be nice but I would probably want to move it into a separate panel-idom package.

For now I've put a IDOM stub object into panel.pane that simply errors when you instantiate it. This is because we did not really telegraph the deprecation.

@philippjfr philippjfr requested a review from hoxbro January 6, 2023 10:57
@codecov
Copy link

codecov bot commented Jan 6, 2023

Codecov Report

Merging #4254 (6c39b15) into main (1ede7de) will decrease coverage by 8.65%.
The diff coverage is 75.00%.

@@            Coverage Diff             @@
##             main    #4254      +/-   ##
==========================================
- Coverage   82.71%   74.06%   -8.66%     
==========================================
  Files         237      235       -2     
  Lines       34276    34129     -147     
==========================================
- Hits        28351    25276    -3075     
- Misses       5925     8853    +2928     
Flag Coverage Δ
ui-tests ?
unitexamples-tests 74.06% <75.00%> (+0.18%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
panel/models/__init__.py 100.00% <ø> (ø)
panel/pane/__init__.py 95.00% <66.66%> (-5.00%) ⬇️
panel/tests/pane/test_base.py 96.07% <100.00%> (ø)
panel/tests/ui/widgets/test_tabulator.py 9.65% <0.00%> (-89.33%) ⬇️
panel/tests/ui/widgets/test_input.py 11.34% <0.00%> (-88.13%) ⬇️
panel/tests/ui/layout/test_accordion.py 14.72% <0.00%> (-85.28%) ⬇️
panel/tests/ui/widgets/test_sliders.py 15.42% <0.00%> (-84.58%) ⬇️
panel/tests/ui/layout/test_card.py 18.01% <0.00%> (-81.99%) ⬇️
panel/tests/ui/io/test_convert.py 15.51% <0.00%> (-80.18%) ⬇️
panel/tests/ui/test_reactive.py 26.53% <0.00%> (-73.47%) ⬇️
... and 29 more

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

Copy link
Member

@hoxbro hoxbro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would classify this as removal, as it no longer exists.

I also think it would be nice to update #4097 with this removal, so we don't forget about the drop.

class IDOM:
def __init__(self, *args, **kwargs):
raise RuntimeError(
"The IDOM pane was deprecated from Panel in version 1.0 "
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"The IDOM pane was deprecated from Panel in version 1.0 "
"The IDOM pane was removed from Panel in version 1.0 "

@@ -146,7 +146,7 @@ def run(self):
'markdown-it-py',
'ipyvuetify',
'reacton',
# Added lxml temporarily as installing pyechars or idom on Python 3.11
# Added lxml temporarily as installing pyecharts or idom on Python 3.11
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# Added lxml temporarily as installing pyecharts or idom on Python 3.11
# Added lxml temporarily as installing pyecharts on Python 3.11

@maximlt
Copy link
Member

maximlt commented Jan 6, 2023

Shouldn't there first be a release deprecating it and then removing it? That might send the signal that Panel can remove things any time.

@philippjfr philippjfr mentioned this pull request Jan 25, 2023
@philippjfr philippjfr closed this Jan 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants