File: TDTMolSupplier.cpp

package info (click to toggle)
rdkit 202503.1-5
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 220,160 kB
  • sloc: cpp: 399,240; python: 77,453; ansic: 25,517; java: 8,173; javascript: 4,005; sql: 2,389; yacc: 1,565; lex: 1,263; cs: 1,081; makefile: 580; xml: 229; fortran: 183; sh: 105
file content (89 lines) | stat: -rw-r--r-- 3,577 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
//
//  Copyright (C) 2005-2021 Greg Landrum and Rational Discovery LLC
//
//   @@ All Rights Reserved @@
//  This file is part of the RDKit.
//  The contents are covered by the terms of the BSD license
//  which is included in the file license.txt, found at the root
//  of the RDKit source tree.
//
#define NO_IMPORT_ARRAY
#include <RDBoost/python.h>
#include <string>

// ours
#include <GraphMol/FileParsers/MolSupplier.h>
#include <GraphMol/RDKitBase.h>
#include "MolSupplier.h"
#include "ContextManagers.h"

namespace python = boost::python;

namespace RDKit {

std::string tdtMolSupplierClassDoc =
    "A class which supplies molecules from a TDT file.\n\
\n\
  Usage examples:\n\
\n\
    1) Lazy evaluation: the molecules are not constructed until we ask for them:\n\n\
       >>> suppl = TDTMolSupplier('in.smi')\n\
       >>> for mol in suppl:\n\
       ...    mol.GetNumAtoms()\n\
\n\
    2) Lazy evaluation 2:\n\n\
       >>> suppl = TDTMolSupplier('in.smi')\n\
       >>> mol1 = next(suppl)\n\
       >>> mol2 = next(suppl)\n\
       >>> suppl.reset()\n\
       >>> mol3 = next(suppl)\n\n\
       # mol3 and mol1 are the same:\
       >>> MolToSmiles(mol3)==MolToSmiles(mol1)\n\
\n\
    3) Random Access:  all molecules are constructed as soon as we ask for the\n\
       length:\n\n\
       >>> suppl = TDTMolSupplier('in.smi')\n\
       >>> nMols = len(suppl)\n\
       >>> for i in range(nMols):\n\
       ...   suppl[i].GetNumAtoms()\n\
\n\
  Properties in the file are used to set properties on each molecule.\n\
  The properties are accessible using the mol.GetProp(propName) method.\n\
\n";
struct tdtmolsup_wrap {
  static void wrap() {
    python::class_<TDTMolSupplier, boost::noncopyable>(
        "TDTMolSupplier", tdtMolSupplierClassDoc.c_str(),
        python::init<>(python::args("self")))
        .def(python::init<std::string, std::string, int, int, bool>(
            (python::arg("self"), python::arg("fileName"),
             python::arg("nameRecord") = "", python::arg("confId2D") = -1,
             python::arg("confId3D") = -1, python::arg("sanitize") = true)))
        .def("__enter__", &MolIOEnter<TDTMolSupplier>,
             python::return_internal_reference<>())
        .def("__exit__", &MolIOExit<TDTMolSupplier>)
        .def("__iter__", &MolSupplIter<TDTMolSupplier>,
             python::return_internal_reference<1>(), python::args("self"))
        .def("__next__", &MolSupplNext<TDTMolSupplier>,
             "Returns the next molecule in the file.  Raises _StopIteration_ "
             "on EOF.\n",
             python::return_value_policy<python::manage_new_object>(),
             python::args("self"))
        .def("__getitem__", &MolSupplGetItem<TDTMolSupplier>,
             python::return_value_policy<python::manage_new_object>(),
             python::args("self", "idx"))
        .def("reset", &TDTMolSupplier::reset, python::args("self"),
             "Resets our position in the file to the beginning.\n")
        .def("__len__", &TDTMolSupplier::length, python::args("self"))
        .def("SetData", &TDTMolSupplier::setData, "Sets the text to be parsed",
             (python::arg("self"), python::arg("data"),
              python::arg("nameRecord") = "", python::arg("confId2D") = -1,
              python::arg("confId3D") = -1, python::arg("sanitize") = true))
        .def("GetItemText", &TDTMolSupplier::getItemText,
             "returns the text for an item",
             (python::arg("self"), python::arg("index")));
  };
};
}  // namespace RDKit

void wrap_tdtsupplier() { RDKit::tdtmolsup_wrap::wrap(); }