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.

Sign up for GitHub

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

Jump to bottom

Result model: Loudly deprecate not needed attributes and remove already deprecated ones #4846

Closed

pekkaklarck opened this issue Aug 25, 2023 · 2 comments

Assignees

Labels

alpha 1 backwards incompatible deprecation effort: medium enhancement priority: medium

Milestone

Member

pekkaklarck commented Aug 25, 2023 •

edited

The result model (robot.result.TestSuite) got separate objects for representing control structures (For, If, ...) only in RF 4.0 (#3749). Before that control structures were modeled as keywords with a type attribute telling what they actually represent. For backwards compatibility the new objects got keywords specific attributes like name. These attributes were deprecated from the beginning and it's not finally time to remove them.

This change will require changing our log file generation code, because it handles control structures as keywords, but that's not too big a problem. The change obviously affects all external tools handling control structures as keywords as well making the change backwards incompatible. We couldn't do it in a bug fix or even in a feature release, but doing it in a major release ought to be fine.

UPDATE: It turned out that we hadn't properly deprecated all the attributes. Some only used our custom @deprecated decorator, but the decorator didn't do anything. Instead of removing these attributes, we decided to change the decorator so that now there's an actual deprecation warning. Those attributes that already emitted deprecation warnings were removed.

The text was updated successfully, but these errors were encountered:

pekkaklarck added enhancement priority: medium backwards incompatible labels

pekkaklarck added this to the v7.0 milestone

pekkaklarck mentioned this issue

Support JSON serialization with result model #4847

Closed

pekkaklarck changed the title ~~Remove deprecated attributes in result model making control structures look like keywords~~ Remove deprecated attributes in result model

yanne self-assigned this

pekkaklarck added the effort: medium label

yanne added a commit that referenced this issue


          libdoc: remove datatypes generation

460fb10

`datatypes` has already been deprecated in favor of `typedocs`
This commit removes the generation of `datatypes` and fixes/removes
associated tests. The schema files have been updated earlier.
Part of #4846

yanne added a commit that referenced this issue


          model: remove deprecated attributes

3f4054e

.keywords and .children have been deprecated since RF 4.0
.critical has also been deprecated a long time

Part of #4846

yanne added a commit that referenced this issue


          jsmodelbuilder: do not use deprecated attrs

d1dc894

part of #4846

yanne added a commit that referenced this issue


          model: remove deprecated attributes

1d4e98f

.keywords and .children have been deprecated since RF 4.0
.critical has also been deprecated a long time

Part of #4846

yanne added a commit that referenced this issue


          jsmodelbuilder: do not use deprecated attrs

dafc3d4

part of #4846

yanne added a commit that referenced this issue


          model: remove deprecated attributes

3fa2383

.keywords and .children have been deprecated since RF 4.0
.critical has also been deprecated a long time

Part of #4846

yanne added a commit that referenced this issue


          jsmodelbuilder: do not use deprecated attrs

3d98ede

part of #4846

yanne pushed a commit that referenced this issue


          model: remove deprecated attributes

f80dca4

.keywords and .children have been deprecated since RF 4.0
.critical has also been deprecated a long time

Part of #4846

yanne pushed a commit that referenced this issue


          jsmodelbuilder: do not use deprecated attrs

7e1f269

part of #4846

yanne pushed a commit that referenced this issue


          model: remove deprecated attributes

6fce4f4

.keywords and .children have been deprecated since RF 4.0
.critical has also been deprecated a long time

Part of #4846

yanne pushed a commit that referenced this issue


          jsmodelbuilder: do not use deprecated attrs

b969f9d

part of #4846

yanne pushed a commit that referenced this issue


          model: remove deprecated attributes

c26444f

.keywords and .children have been deprecated since RF 4.0
.critical has also been deprecated a long time

Part of #4846

yanne pushed a commit that referenced this issue


          jsmodelbuilder: do not use deprecated attrs

3cab79d

part of #4846

yanne pushed a commit that referenced this issue


          model: remove deprecated attributes

93073af

.keywords and .children have been deprecated since RF 4.0
.critical has also been deprecated a long time

Part of #4846

yanne pushed a commit that referenced this issue


          jsmodelbuilder: do not use deprecated attrs

7487fa1

part of #4846

pekkaklarck changed the title ~~Remove deprecated attributes in result model~~ Result model: Loudly deprecate not needed attributes and remove already deprecated ones

pekkaklarck added the deprecation label

pekkaklarck mentioned this issue

Result model: Add message to keywords and control structures and remove doc from controls #4883

Closed

pekkaklarck added a commit that referenced this issue


          Result model: Add message to body items, remove doc from controls.

42b90ee

Fixes #4883. Doc is now deprecated as part of #4846, but it will be
removed in the future.

pekkaklarck closed this as completed

pekkaklarck added the alpha 1 label

Member Author

pekkaklarck commented Nov 8, 2023

The following attributes were removed from the result model. They all had been deprecated since RF 4.0.

TestCase.keywords. Use TestCase.body, TestCase.setup and TestCase.teardown instead.
TestSuite.keywords. Use TestSuite.setup and TestSuite.teardown instead.
Keyword.keywords. Use Keyword.body and Keyword.teardown instead.
Keyword.children. Use Keyword.body instead.
TestCase.critical. The whole criticality concept has been removed.

TestCase.keywords and TestSuite.keywords were also present in the execution model and removed from there as well.

Member Author

pekkaklarck commented Nov 9, 2023

Control structures were earlier masked to look like keywords. Nowadays they are considered totally different and their attributes name, kwnane, libname, doc, args, assign, tags and timeout have been "loudly" deprecated.

pekkaklarck added a commit that referenced this issue


          Result control stuctures: Enhance deprecation of keyword facade.

1cb8acb

- Enhance the deprecation warning.
- Deprecate also `doc`.
- Enhance tests.

Missing part of #4846.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment