Skip to content

Deprecate Timestep as argument for writers #2043

@orbeckst

Description

@orbeckst

As discussed in #206 we want to streamline the trajectory writer interface so that

Writer.write(arg)

only accepts AtomGroup or Universe as arg but not Timestep anymore. (We can't think of a good reason when we would have a Timestep but not an AG.)

  • deprecate the part of base.Writer.write()
    if isinstance(obj, Timestep):
    that can directly take a Timestep
  • check all specific Writers that we don't override
  • add comments that in 1.0 supplying a Timestep will raise a TypeError
  • add tests for all writers that check for the deprecation warning (and can later be turned into tests that check for TypeError)
  • check docs and replace deprecated usage

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions