Files
rdkit/Code/GraphMol/Wrap/MaeMolSupplier.cpp
Brian Kelley 4c1ea25fda Fix a hang when trying to read mols from a directory not a file on linux (#2983)
* Fix a hang when trying to read mols from a directory not a file on linux

* thrown an exception at construction time

* clarify the readme

* update release notes

* Refactor the stream opening and checking code to a common method

Co-authored-by: Brian Kelley <bkelley@relaytx.com>
Co-authored-by: Greg Landrum <greg.landrum@gmail.com>
2020-03-09 15:27:58 +01:00

133 lines
4.5 KiB
C++

// Copyright (C) 2018 Lorton
//
// @@ 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>
#include <fstream>
// ours
#include <RDGeneral/BadFileException.h>
#include <RDGeneral/FileParseException.h>
#include <GraphMol/FileParsers/MolSupplier.h>
#include <GraphMol/RDKitBase.h>
#include <RDBoost/python_streambuf.h>
#include <RDBoost/iterator_next.h>
#include <maeparser/MaeConstants.hpp>
#include <maeparser/Reader.hpp>
#include "MolSupplier.h"
namespace python = boost::python;
using namespace schrodinger;
using boost_adaptbx::python::streambuf;
namespace {
bool streamIsGoodOrExhausted(std::istream *stream) {
PRECONDITION(stream, "bad stream");
return stream->good() || (stream->eof() && stream->fail() && !stream->bad());
}
class LocalMaeMolSupplier : public RDKit::MaeMolSupplier {
public:
LocalMaeMolSupplier(python::object &input, bool sanitize, bool removeHs) {
// FIX: minor leak here
auto *sb = new streambuf(input);
dp_inStream = new streambuf::istream(*sb);
dp_sInStream.reset(dp_inStream);
df_owner = true;
df_sanitize = sanitize;
df_removeHs = removeHs;
d_reader.reset(new mae::Reader(dp_sInStream));
CHECK_INVARIANT(streamIsGoodOrExhausted(dp_inStream), "bad instream");
try {
d_next_struct = d_reader->next(mae::CT_BLOCK);
} catch (const mae::read_exception &e) {
throw RDKit::FileParseException(e.what());
}
}
LocalMaeMolSupplier(streambuf &input, bool sanitize, bool removeHs) {
dp_inStream = new streambuf::istream(input);
dp_sInStream.reset(dp_inStream);
df_owner = true;
df_sanitize = sanitize;
df_removeHs = removeHs;
d_reader.reset(new mae::Reader(dp_sInStream));
CHECK_INVARIANT(streamIsGoodOrExhausted(dp_inStream), "bad instream");
try {
d_next_struct = d_reader->next(mae::CT_BLOCK);
} catch (const mae::read_exception &e) {
throw RDKit::FileParseException(e.what());
}
}
LocalMaeMolSupplier(const std::string &fname, bool sanitize = true,
bool removeHs = true)
: RDKit::MaeMolSupplier(fname, sanitize, removeHs) {}
}; // namespace
LocalMaeMolSupplier *FwdMolSupplIter(LocalMaeMolSupplier *self) { return self; }
} // namespace
namespace RDKit {
std::string maeMolSupplierClassDoc =
"A class which supplies molecules from file-like object containing Maestro data.\n\
\n\
Usage examples:\n\
\n\
1) Lazy evaluation: the molecules are not constructed until we ask for them:\n\n\
>>> suppl = MaeMolSupplier(file('in.mae'))\n\
>>> for mol in suppl:\n\
... if mol is not None: mol.GetNumAtoms()\n\
\n\
2) we can also read from compressed files: \n\n\
>>> import gzip\n\
>>> suppl = MaeMolSupplier(gzip.open('in.maegz'))\n\
>>> for mol in suppl:\n\
... if mol is not None: print mol.GetNumAtoms()\n\
\n\
Properties in the Maestro file are used to set properties on each molecule.\n\
The properties are accessible using the mol.GetProp(propName) method.\n\
\n";
struct maemolsup_wrap {
static void wrap() {
python::class_<LocalMaeMolSupplier, boost::noncopyable>(
"MaeMolSupplier", maeMolSupplierClassDoc.c_str(), python::no_init)
.def(python::init<python::object &, bool, bool>(
(python::arg("fileobj"), python::arg("sanitize") = true,
python::arg("removeHs") =
true))[python::with_custodian_and_ward_postcall<0, 2>()])
.def(python::init<streambuf &, bool, bool>(
(python::arg("streambuf"), python::arg("sanitize") = true,
python::arg("removeHs") =
true))[python::with_custodian_and_ward_postcall<0, 2>()])
.def(python::init<std::string, bool, bool>(
(python::arg("filename"), python::arg("sanitize") = true,
python::arg("removeHs") = true)))
.def(NEXT_METHOD, (ROMol * (*)(LocalMaeMolSupplier *)) & MolSupplNext,
"Returns the next molecule in the file. Raises _StopIteration_ "
"on EOF.\n",
python::return_value_policy<python::manage_new_object>())
.def("atEnd", &MaeMolSupplier::atEnd,
"Returns whether or not we have hit EOF.\n")
.def("__iter__", &FwdMolSupplIter,
python::return_internal_reference<1>());
};
};
} // namespace RDKit
void wrap_maesupplier() { RDKit::maemolsup_wrap::wrap(); }